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>

The IdValidation enum determines the type value that are valid for an Id. By default null is not allowed, and 0 is not allow for singleton ids of long or int type. The default value is ZERO for singleton ids, and NULL for composite ids. This can be set using the @PrimaryKey annotation, or ClassDescriptor API.

See Also:

PrimaryKey, ClassDescriptor.setIdValidation(IdValidation)

Author:

James Sutherland

Since:

EclipseLink 1.0

Enum Constant Summary

NONE
No id validation is done.

NULL
Only null is not allowed as an id value, 0 is allowed.

ZERO
null and 0 are not allowed, (only int and long).

Method Summary

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 not allowed as an id value, 0 is allowed.

ZERO

public static final IdValidation ZERO

null and 0 are not allowed, (only int and long).

NONE

public static final IdValidation NONE

No id validation is done.

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