Package org.eclipse.persistence.annotations

Enum ExistenceType

java.lang.Object

java.lang.Enum<ExistenceType>

org.eclipse.persistence.annotations.ExistenceType

All Implemented Interfaces:

Serializable, Comparable<ExistenceType>

public enum ExistenceType
extends Enum<ExistenceType>

An enum that is used within the ExistenceChecking annotation.

Since:

EclipseLink 1.0

Author:

Guy Pelletier

See Also:

ExistenceChecking, DoesExistQuery

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSUME_EXISTENCE	Assume that if the objects primary key does not include null then it must exist.
ASSUME_NON_EXISTENCE	Assume that the object does not exist.
CHECK_CACHE	Assume that if the objects primary key does not include null and it is in the cache, then it must exist.
CHECK_DATABASE	Perform does exist check on the database.

Method Summary

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

CHECK_CACHE

public static final ExistenceType CHECK_CACHE

Assume that if the objects primary key does not include null and it is in the cache, then it must exist.

CHECK_DATABASE

public static final ExistenceType CHECK_DATABASE

Perform does exist check on the database.

ASSUME_EXISTENCE

public static final ExistenceType ASSUME_EXISTENCE

Assume that if the objects primary key does not include null then it must exist. This may be used if the application guarantees or does not care about the existence check.

ASSUME_NON_EXISTENCE

public static final ExistenceType ASSUME_NON_EXISTENCE

Assume that the object does not exist. This may be used if the application guarantees or does not care about the existence check. This will always force an insert to be called.

Method Detail

values

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

Returns:

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

valueOf

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