org.hibernate.boot.model.source.spi

Enum PluralAttributeIndexNature

java.lang.Object

java.lang.Enum<PluralAttributeIndexNature>

org.hibernate.boot.model.source.spi.PluralAttributeIndexNature

All Implemented Interfaces:

Serializable, Comparable<PluralAttributeIndexNature>

public enum PluralAttributeIndexNature
extends Enum<PluralAttributeIndexNature>

Describes the nature of plural attribute indexes in terms of relational implications.

Author:

Steve Ebersole

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE The map key is an aggregated composite
BASIC The collection indexes are basic, simple values.
MANY_TO_ANY The map key is represented by a Hibernate ANY mapping
MANY_TO_MANY The map key is an association identified by a column(s) on the collection table.
SEQUENTIAL A sequential array/list index

Method Summary

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

SEQUENTIAL

public static final PluralAttributeIndexNature SEQUENTIAL

A sequential array/list index

BASIC

public static final PluralAttributeIndexNature BASIC

The collection indexes are basic, simple values.

AGGREGATE

public static final PluralAttributeIndexNature AGGREGATE

The map key is an aggregated composite

MANY_TO_MANY

public static final PluralAttributeIndexNature MANY_TO_MANY

The map key is an association identified by a column(s) on the collection table.

MANY_TO_ANY

public static final PluralAttributeIndexNature MANY_TO_ANY

The map key is represented by a Hibernate ANY mapping

Method Detail

values

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

Returns:

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

valueOf

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