com.allanbank.mongodb.client

Enum ClusterType

java.lang.Object

java.lang.Enum<ClusterType>

com.allanbank.mongodb.client.ClusterType

All Implemented Interfaces:

Serializable, Comparable<ClusterType>

public enum ClusterType
extends Enum<ClusterType>

ClusterType provides an enumeration of the types of cluster configurations supported.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
REPLICA_SET The replica set type cluster.
SHARDED The sharded type cluster using 'mongos' servers.
STAND_ALONE A single 'mongod' server.

Method Summary

Methods

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

REPLICA_SET

public static final ClusterType REPLICA_SET

The replica set type cluster.

SHARDED

public static final ClusterType SHARDED

The sharded type cluster using 'mongos' servers.

STAND_ALONE

public static final ClusterType STAND_ALONE

A single 'mongod' server.

Method Detail

values

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

Returns:

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

valueOf

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