org.eclipse.persistence.annotations

Enum IdValidation

java.lang.Object

java.lang.Enum<IdValidation>

org.eclipse.persistence.annotations.IdValidation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IdValidation>

public enum IdValidation
extends java.lang.Enum<IdValidation>

IdValidation configures which id values are considered valid when loading from the database. This configuration is set either using the PrimaryKey annotation or using the ClassDescriptor API. This configuration is also used to determine if a sequence number is required.

See Also:

PrimaryKey.validation(), ClassDescriptor.setIdValidation(IdValidation)

Author:

James Sutherland

Since:

EclipseLink 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEGATIVE null, 0 and negative values are not allowed for ids extending Number and primitive int and long ids.
NONE No identifier validation is performed.
NULL Only null is invalid All other values are considered valid.
ZERO null and 0 are not allowed for primitive int and long ids.

Method Summary

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

NULL

public static final IdValidation NULL

Only null is invalid All other values are considered valid. This is the default configuration when composite identifiers are used and sequencing is not used.

ZERO

public static final IdValidation ZERO

null and 0 are not allowed for primitive int and long ids. This is the default configuration for a simple identifier.

NEGATIVE

public static final IdValidation NEGATIVE

null, 0 and negative values are not allowed for ids extending Number and primitive int and long ids.

NONE

public static final IdValidation NONE

No identifier validation is performed.

Method Detail

values

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

Returns:

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

valueOf

public static IdValidation valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null