org.hibernate.annotations

Enum NotFoundAction

java.lang.Object

java.lang.Enum<NotFoundAction>

org.hibernate.annotations.NotFoundAction

All Implemented Interfaces:

Serializable, Comparable<NotFoundAction>

public enum NotFoundAction
extends Enum<NotFoundAction>

Possible actions when an associated entity is not found in the database. Often seen with "legacy" foreign-key schemes which do not use NULL to indicate a missing reference, instead using a "magic value".

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION Raise an exception when an element is not found (default and recommended).
IGNORE Ignore the element when not found in database.

Method Summary

Methods

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

EXCEPTION

public static final NotFoundAction EXCEPTION

Raise an exception when an element is not found (default and recommended).

IGNORE

public static final NotFoundAction IGNORE

Ignore the element when not found in database.

Method Detail

values

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

Returns:

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

valueOf

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