com.allanbank.mongodb.client.state

Enum Server.State

java.lang.Object

java.lang.Enum<Server.State>

com.allanbank.mongodb.client.state.Server.State

All Implemented Interfaces:

Serializable, Comparable<Server.State>

Enclosing class:

Server

public static enum Server.State
extends Enum<Server.State>

State provides the possible sttes for a server within the MongoDB cluster.

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 ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
READ_ONLY We can send reads to the server.
UNAVAILABLE We cannot connect to the server.
UNKNOWN A transient state for the server.
WRITABLE We can send writes to the server.

Method Summary

Methods

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

READ_ONLY

public static final Server.State READ_ONLY

We can send reads to the server. It is running, we can connect to it and is a secondary in the replica set.

UNAVAILABLE

public static final Server.State UNAVAILABLE

We cannot connect to the server.

UNKNOWN

public static final Server.State UNKNOWN

A transient state for the server. We have either never connected to the server or have lost all of the connections to the server.

WRITABLE

public static final Server.State WRITABLE

We can send writes to the server. It is running, we can connect to it and is either a stand-alone instance, the primary in the replica set or a mongos.

Method Detail

values

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

Returns:

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

valueOf

public static Server.State 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