net.openhft.chronicle.testframework

Enum NetworkUtil

java.lang.Object

java.lang.Enum<NetworkUtil>

net.openhft.chronicle.testframework.NetworkUtil

All Implemented Interfaces:

Serializable, Comparable<NetworkUtil>

public enum NetworkUtil
extends Enum<NetworkUtil>

Utility class to provide network-related functionalities.

This class includes methods to interact with network resources, such as finding an available port.

Method Summary

Modifier and Type	Method and Description
static int	getAvailablePort() Retrieves an available port number on the local machine.
static NetworkUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static NetworkUtil[]	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

Method Detail

values

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

Returns:

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

valueOf

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

getAvailablePort

public static int getAvailablePort()

Retrieves an available port number on the local machine.

This method attempts to bind to an automatically allocated port, then returns the port number. It provides a simple way to find a port that's very likely to be available.

Returns:

a port number that is likely to be available for binding

Throws:

RuntimeException - if an IOException occurs while trying to create a ServerSocket