org.hibernate.ogm.datastore.mongodb.options

Enum AssociationDocumentType

java.lang.Object

java.lang.Enum<AssociationDocumentType>

org.hibernate.ogm.datastore.mongodb.options.AssociationDocumentType

All Implemented Interfaces:

Serializable, Comparable<AssociationDocumentType>

public enum AssociationDocumentType
extends Enum<AssociationDocumentType>

Strategies for storing MongoDB association documents.

Author:

Gunnar Morling

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLLECTION_PER_ASSOCIATION Stores the association in a dedicated MongoDB collection per association
GLOBAL_COLLECTION Stores the association info in the same MongoDB collection for all associations

Method Summary

Methods

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

GLOBAL_COLLECTION

public static final AssociationDocumentType GLOBAL_COLLECTION

Stores the association info in the same MongoDB collection for all associations

COLLECTION_PER_ASSOCIATION

public static final AssociationDocumentType COLLECTION_PER_ASSOCIATION

Stores the association in a dedicated MongoDB collection per association

Method Detail

values

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

Returns:

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

valueOf

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