1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 package org.apache.hc.core5.net; 28 29 import org.apache.hc.core5.util.Args; 30 31 /** 32 * Port helper methods. 33 * 34 * @since 5.0 35 */ 36 public class Ports { 37 38 /** 39 * The scheme default port. 40 */ 41 public final static int SCHEME_DEFAULT = -1; 42 43 /** 44 * The minimum port value per https://tools.ietf.org/html/rfc6335. 45 */ 46 public final static int MIN_VALUE = 0; 47 48 /** 49 * The maxium port value per https://tools.ietf.org/html/rfc6335. 50 */ 51 public final static int MAX_VALUE = 65535; 52 53 /** 54 * Checks a port number where {@code -1} indicates the scheme default port. 55 * 56 * @param port 57 * The port to check where {@code -1} indicates the scheme default port. 58 * @return the port 59 * 60 * @throws IllegalArgumentException 61 * If the port parameter is outside the specified range of valid port values, which is between 0 and 62 * 65535, inclusive. {@code -1} indicates the scheme default port. 63 */ 64 public static int checkWithDefault(final int port) { 65 return Args.checkRange(port, SCHEME_DEFAULT, MAX_VALUE, 66 "Port number(Use -1 to specify the scheme default port)"); 67 } 68 69 /** 70 * Checks a port number. 71 * 72 * @param port 73 * The port to check. 74 * @return the port 75 * 76 * @throws IllegalArgumentException 77 * If the port parameter is outside the specified range of valid port values, which is between 0 and 78 * 65535, inclusive. 79 */ 80 public static int check(final int port) { 81 return Args.checkRange(port, MIN_VALUE, MAX_VALUE, "Port number"); 82 } 83 84 }