org.hibernate.ogm.datastore.mongodb
Enum AssociationStorage

java.lang.Object
  java.lang.Enum<AssociationStorage>
      org.hibernate.ogm.datastore.mongodb.AssociationStorage

All Implemented Interfaces:

Serializable, Comparable<AssociationStorage>

public enum AssociationStorage
extends Enum<AssociationStorage>

Defines the various association storage strategies

Author:

Alan Fitton , Emmanuel Bernard

Enum Constant Summary

COLLECTION
Store the association in a dedicated MongoDB collection per association

GLOBAL_COLLECTION
Store the association info in a unique MongoDB collection for all associations

IN_ENTITY
Store association information from within the entity

Method Summary

static AssociationStorage	valueOf(String name) Returns the enum constant of this type with the specified name.
static AssociationStorage[]	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 AssociationStorage GLOBAL_COLLECTION

Store the association info in a unique MongoDB collection for all associations

COLLECTION

public static final AssociationStorage COLLECTION

Store the association in a dedicated MongoDB collection per association

IN_ENTITY

public static final AssociationStorage IN_ENTITY

Store association information from within the entity

Method Detail

values

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

Returns:

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

valueOf

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