org.springframework.util

Enum SocketUtils.SocketType

java.lang.Object

java.lang.Enum<SocketUtils.SocketType>

org.springframework.util.SocketUtils.SocketType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SocketUtils.SocketType>

Enclosing class:

SocketUtils

private static enum SocketUtils.SocketType
extends java.lang.Enum<SocketUtils.SocketType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
TCP
UDP

Method Summary

Modifier and Type	Method and Description
(package private) int	findAvailablePort(int minPort, int maxPort) Find an available port for this SocketType, randomly selected from the range [minPort, maxPort].
(package private) java.util.SortedSet<java.lang.Integer>	findAvailablePorts(int numRequested, int minPort, int maxPort) Find the requested number of available ports for this SocketType, each randomly selected from the range [minPort, maxPort].
private int	findRandomPort(int minPort, int maxPort) Find a pseudo-random port number within the range [minPort, maxPort].
protected abstract boolean	isPortAvailable(int port) Determine if the specified port for this SocketType is currently available on localhost.
static SocketUtils.SocketType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SocketUtils.SocketType[]	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

Enum Constant Detail

TCP

public static final SocketUtils.SocketType TCP

UDP

public static final SocketUtils.SocketType UDP

Method Detail

values

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

Returns:

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

valueOf

public static SocketUtils.SocketType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isPortAvailable

protected abstract boolean isPortAvailable(int port)

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

findRandomPort

private int findRandomPort(int minPort,
                 int maxPort)

Find a pseudo-random port number within the range [minPort, maxPort].

Parameters:

minPort - the minimum port number

maxPort - the maximum port number

Returns:

a random port number within the specified range

findAvailablePort

int findAvailablePort(int minPort,
                    int maxPort)

Find an available port for this SocketType, randomly selected from the range [minPort, maxPort].

Parameters:

minPort - the minimum port number

maxPort - the maximum port number

Returns:

an available port number for this socket type

Throws:

java.lang.IllegalStateException - if no available port could be found

findAvailablePorts

java.util.SortedSet<java.lang.Integer> findAvailablePorts(int numRequested,
                                                        int minPort,
                                                        int maxPort)

Find the requested number of available ports for this SocketType, each randomly selected from the range [minPort, maxPort].

Parameters:

numRequested - the number of available ports to find

minPort - the minimum port number

maxPort - the maximum port number

Returns:

a sorted set of available port numbers for this socket type

Throws:

java.lang.IllegalStateException - if the requested number of available ports could not be found