Package com.mongodb.connection

Enum ClusterConnectionMode

java.lang.Object

java.lang.Enum<ClusterConnectionMode>

com.mongodb.connection.ClusterConnectionMode

All Implemented Interfaces:

Serializable, Comparable<ClusterConnectionMode>

public enum ClusterConnectionMode
extends Enum<ClusterConnectionMode>

The cluster connection mode.

Since:

3.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOAD_BALANCED	Connect to one or more mongos servers via a load balancer
MULTIPLE	Connect to multiple servers in a cluster (either a replica set or multiple mongos servers)
SINGLE	Connect directly to a server, regardless of the type of cluster it is a part of.

Method Summary

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

SINGLE

public static final ClusterConnectionMode SINGLE

Connect directly to a server, regardless of the type of cluster it is a part of.

MULTIPLE

public static final ClusterConnectionMode MULTIPLE

Connect to multiple servers in a cluster (either a replica set or multiple mongos servers)

LOAD_BALANCED

public static final ClusterConnectionMode LOAD_BALANCED

Connect to one or more mongos servers via a load balancer

Since:

4.3

Method Detail

values

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

Returns:

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

valueOf

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