com.helger.network.port

Enum ENetworkProtocol

java.lang.Object

java.lang.Enum<ENetworkProtocol>

com.helger.network.port.ENetworkProtocol

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<ENetworkProtocol>

public enum ENetworkProtocol
extends Enum<ENetworkProtocol>
implements com.helger.commons.id.IHasID<String>

Network protocol enumeration.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
TCP
UDP

Method Summary

Modifier and Type	Method and Description
static ENetworkProtocol	getFromIDOrNull(String sID)
String	getID()
abstract boolean	isPortAvailable(int nPort) Determine if the specified port for this type is currently available on localhost.
boolean	isPortUsed(int nPort) Determine if the specified port for this type is currently used on localhost.
static ENetworkProtocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static ENetworkProtocol[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Enum Constant Detail

TCP

public static final ENetworkProtocol TCP

UDP

public static final ENetworkProtocol UDP

Method Detail

values

public static ENetworkProtocol[] 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 (ENetworkProtocol c : ENetworkProtocol.values())
    System.out.println(c);

Returns:

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

valueOf

public static ENetworkProtocol 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

isPortAvailable

public abstract boolean isPortAvailable(int nPort)

Determine if the specified port for this type is currently available on localhost.

Parameters:

nPort - The port to check. Must be > 0 and < 0xffff

Returns:

true if the port is available, false if not.

See Also:

isPortUsed(int)

isPortUsed

public boolean isPortUsed(int nPort)

Determine if the specified port for this type is currently used on localhost.

Parameters:

nPort - The port to check. Must be > 0 and < 0xffff

Returns:

true if the port is used, false if not.

See Also:

isPortAvailable(int)

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getFromIDOrNull

@Nullable
public static ENetworkProtocol getFromIDOrNull(@Nullable
                                                          String sID)