com.unboundid.ldap.sdk

Enum RoundRobinDNSServerSet.AddressSelectionMode

java.lang.Object

java.lang.Enum<RoundRobinDNSServerSet.AddressSelectionMode>

com.unboundid.ldap.sdk.RoundRobinDNSServerSet.AddressSelectionMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RoundRobinDNSServerSet.AddressSelectionMode>

Enclosing class:

RoundRobinDNSServerSet

public static enum RoundRobinDNSServerSet.AddressSelectionMode
extends java.lang.Enum<RoundRobinDNSServerSet.AddressSelectionMode>

An enum that defines the modes that may be used to select the order in which addresses should be used in attempts to establish connections.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILOVER The address selection mode that will cause addresses to be consistently attempted in the order they are retrieved from the name service.
RANDOM The address selection mode that will cause the order of addresses to be randomized for each attempt.
ROUND_ROBIN The address selection mode that will cause connection attempts to be made in a round-robin order.

Method Summary

Modifier and Type	Method and Description
static RoundRobinDNSServerSet.AddressSelectionMode	forName(java.lang.String name) Retrieves the address selection mode with the specified name.
static RoundRobinDNSServerSet.AddressSelectionMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RoundRobinDNSServerSet.AddressSelectionMode[]	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

FAILOVER

public static final RoundRobinDNSServerSet.AddressSelectionMode FAILOVER

The address selection mode that will cause addresses to be consistently attempted in the order they are retrieved from the name service.

RANDOM

public static final RoundRobinDNSServerSet.AddressSelectionMode RANDOM

The address selection mode that will cause the order of addresses to be randomized for each attempt.

ROUND_ROBIN

public static final RoundRobinDNSServerSet.AddressSelectionMode ROUND_ROBIN

The address selection mode that will cause connection attempts to be made in a round-robin order.

Method Detail

values

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

Returns:

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

valueOf

public static RoundRobinDNSServerSet.AddressSelectionMode 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

forName

@Nullable
public static RoundRobinDNSServerSet.AddressSelectionMode forName(@NotNull
                                                                            java.lang.String name)

Retrieves the address selection mode with the specified name.

Parameters:

name - The name of the address selection mode to retrieve. It must not be null.

Returns:

The requested address selection mode, or null if no such change mode is defined.