com.github.rvesse.airline.annotations.restrictions

Enum PortType

java.lang.Object

java.lang.Enum<PortType>

com.github.rvesse.airline.annotations.restrictions.PortType

All Implemented Interfaces:

Serializable, Comparable<PortType>

public enum PortType
extends Enum<PortType>
implements Comparable<PortType>

Port types

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Any port
DYNAMIC The dynamic ports (aka private or ephemeral ports), these are ports 49152 to 65535 which are never assigned by the IANA
OS_ALLOCATED Port 0 i.e.
SYSTEM The system (aka well known or privileged ports), these are ports 1 to 1023 and usually require adminstrative privileges
USER The user ports (aka registered ports), these are ports 1024 to 49151 and which may be registered and assigned by the IANA

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(PortType other) Gets whether the port type contains another port type i.e.
int	getMaximumPort() Gets the maximum port
int	getMinimumPort() Gets the minimum port
boolean	inRange(int port) Gets whether a port falls within the range of this port type
static String	toRangesString(Iterable<PortType> portTypes) Gets a string denoting all the acceptable port ranges
String	toString()
static PortType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PortType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

ANY

public static final PortType ANY

Any port

OS_ALLOCATED

public static final PortType OS_ALLOCATED

Port 0 i.e. the special port that has the OS allocate an available port

SYSTEM

public static final PortType SYSTEM

The system (aka well known or privileged ports), these are ports 1 to 1023 and usually require adminstrative privileges

USER

public static final PortType USER

The user ports (aka registered ports), these are ports 1024 to 49151 and which may be registered and assigned by the IANA

DYNAMIC

public static final PortType DYNAMIC

The dynamic ports (aka private or ephemeral ports), these are ports 49152 to 65535 which are never assigned by the IANA

Method Detail

values

public static PortType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PortType c : PortType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PortType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMinimumPort

public int getMinimumPort()

Gets the minimum port

Returns:

Minimum port

getMaximumPort

public int getMaximumPort()

Gets the maximum port

Returns:

Maximum port

inRange

public boolean inRange(int port)

Gets whether a port falls within the range of this port type

Parameters:

port - Port

Returns:

True if in range, false otherwise

contains

public boolean contains(PortType other)

Gets whether the port type contains another port type i.e. does this cover at least the same range of ports as the other

Parameters:

other - Other port type

Returns:

True if this covers at least the same range of ports as the other, false otherwise

toString

public String toString()

Overrides:

toString in class Enum<PortType>

toRangesString

public static String toRangesString(Iterable<PortType> portTypes)

Gets a string denoting all the acceptable port ranges

Parameters:

portTypes - Port types

Returns:

String detailing acceptable ranges