org.hibernate.ogm.datastore.mongodb.options

Enum ReadConcernType

java.lang.Object

java.lang.Enum<ReadConcernType>

org.hibernate.ogm.datastore.mongodb.options.ReadConcernType

All Implemented Interfaces:

Serializable, Comparable<ReadConcernType>

public enum ReadConcernType
extends Enum<ReadConcernType>

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

Author:

Aleksandr Mylnikov

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Default read concern.
LINEARIZABLE The query returns data that reflects all successful majority-acknowledged writes that completed prior to the start of the read operation.
LOCAL The query returns data from the instance with no guarantee that the data has been written to a majority of the replica set members (i.e.
MAJORITY The query returns data that has been acknowledged by a majority of the replica set members.

Method Summary

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

DEFAULT

public static final ReadConcernType DEFAULT

Default read concern. Means that there is no replica set

LOCAL

public static final ReadConcernType LOCAL

The query returns data from the instance with no guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back).

MAJORITY

public static final ReadConcernType MAJORITY

The query returns data that has been acknowledged by a majority of the replica set members. The documents returned by the read operation are durable, even in the event of failure.

LINEARIZABLE

public static final ReadConcernType LINEARIZABLE

The query returns data that reflects all successful majority-acknowledged writes that completed prior to the start of the read operation. The query may wait for concurrently executing writes to propagate to a majority of replica set members before returning results.

Method Detail

values

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

Returns:

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

valueOf

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

getReadConcern

public com.mongodb.ReadConcern getReadConcern()