com.mongodb

Enum ServerType

java.lang.Object

java.lang.Enum<ServerType>

com.mongodb.ServerType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ServerType>

enum ServerType
extends java.lang.Enum<ServerType>

The type of the server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ReplicaSetArbiter A replica set arbiter.
ReplicaSetGhost A replica set member that does not report a set name or a hosts list
ReplicaSetOther A replica set member that is none of the other types (a passive, for example).
ReplicaSetPrimary A replica set primary.
ReplicaSetSecondary A replica set secondary.
ShardRouter A router to a sharded cluster, i.e.
StandAlone A standalone mongod server.
Unknown The server type is not yet known.

Method Summary

Modifier and Type	Method and Description
abstract ClusterType	getClusterType() The type of the cluster to which this server belongs
static ServerType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ServerType[]	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

StandAlone

public static final ServerType StandAlone

A standalone mongod server.

ReplicaSetPrimary

public static final ServerType ReplicaSetPrimary

A replica set primary.

ReplicaSetSecondary

public static final ServerType ReplicaSetSecondary

A replica set secondary.

ReplicaSetArbiter

public static final ServerType ReplicaSetArbiter

A replica set arbiter.

ReplicaSetOther

public static final ServerType ReplicaSetOther

A replica set member that is none of the other types (a passive, for example).

ReplicaSetGhost

public static final ServerType ReplicaSetGhost

A replica set member that does not report a set name or a hosts list

ShardRouter

public static final ServerType ShardRouter

A router to a sharded cluster, i.e. a mongos server.

Unknown

public static final ServerType Unknown

The server type is not yet known.

Method Detail

values

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

Returns:

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

valueOf

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

getClusterType

public abstract ClusterType getClusterType()

The type of the cluster to which this server belongs

Returns:

the cluster type