org.hibernate.ogm.datastore.mongodb.options

Enum ReadPreferenceType

java.lang.Object

java.lang.Enum<ReadPreferenceType>

org.hibernate.ogm.datastore.mongodb.options.ReadPreferenceType

All Implemented Interfaces:

Serializable, Comparable<ReadPreferenceType>

public enum ReadPreferenceType
extends Enum<ReadPreferenceType>

Read preference options for MongoDB. Represents the defined strategies from ReadPreference.

Author:

Gunnar Morling

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEAREST Read from the nearest node.
PRIMARY Read from the primary node only.
PRIMARY_PREFERRED Read from the primary node if possible.
SECONDARY Read from a secondary node only.
SECONDARY_PREFERRED Read from a secondary node if possible, from primary otherwise.

Method Summary

Modifier and Type	Method and Description
com.mongodb.ReadPreference	getReadPreference() Get the read preference.
static ReadPreferenceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReadPreferenceType[]	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

PRIMARY

public static final ReadPreferenceType PRIMARY

Read from the primary node only.

PRIMARY_PREFERRED

public static final ReadPreferenceType PRIMARY_PREFERRED

Read from the primary node if possible.

SECONDARY

public static final ReadPreferenceType SECONDARY

Read from a secondary node only.

SECONDARY_PREFERRED

public static final ReadPreferenceType SECONDARY_PREFERRED

Read from a secondary node if possible, from primary otherwise.

NEAREST

public static final ReadPreferenceType NEAREST

Read from the nearest node.

Method Detail

values

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

Returns:

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

valueOf

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

getReadPreference

public com.mongodb.ReadPreference getReadPreference()

Get the read preference.

Returns:

the ReadPreference associated with this enum value.