com.datastax.oss.driver.api.core.loadbalancing

Enum NodeDistance

java.lang.Object

java.lang.Enum<NodeDistance>

com.datastax.oss.driver.api.core.loadbalancing.NodeDistance

All Implemented Interfaces:

Serializable, Comparable<NodeDistance>

public enum NodeDistance
extends Enum<NodeDistance>

Determines how the driver will manage connections to a Cassandra node.

The distance is assigned by a LoadBalancingPolicy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORED An "inactive" distance, that indicates that the driver will not open any connection to the node.
LOCAL An "active" distance that, indicates that the driver should maintain connections to the node; it also marks it as "preferred", meaning that the number or capacity of the connections may be higher, and that the node may also have priority for some tasks (for example, being chosen as the control host).
REMOTE An "active" distance that, indicates that the driver should maintain connections to the node; it also marks it as "less preferred", meaning that the number or capacity of the connections may be lower, and that other nodes may have a higher priority for some tasks (for example, being chosen as the control host).

Method Summary

Modifier and Type	Method and Description
static NodeDistance	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeDistance[]	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

LOCAL

public static final NodeDistance LOCAL

An "active" distance that, indicates that the driver should maintain connections to the node; it also marks it as "preferred", meaning that the number or capacity of the connections may be higher, and that the node may also have priority for some tasks (for example, being chosen as the control host).

REMOTE

public static final NodeDistance REMOTE

An "active" distance that, indicates that the driver should maintain connections to the node; it also marks it as "less preferred", meaning that the number or capacity of the connections may be lower, and that other nodes may have a higher priority for some tasks (for example, being chosen as the control host).

IGNORED

public static final NodeDistance IGNORED

An "inactive" distance, that indicates that the driver will not open any connection to the node.

Method Detail

values

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

Returns:

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

valueOf

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