org.glassfish.pfl.dynamic.copyobject.spi

Enum CopyType

java.lang.Object

java.lang.Enum<CopyType>

org.glassfish.pfl.dynamic.copyobject.spi.CopyType

All Implemented Interfaces:

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

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

Enum used with Copy annotation on fields to indicate special handling by the object copier. In what follows, the source is the object being copied, and the result is the resulting copy. field is the name of the annotated field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IDENTITY Set result.field = source.field without copying
NULL Set result.field = null or 0 according to type.
RECURSE Standard behavior: apply standard copier to the value of the field.
RESULT Set result.field = result.
SOURCE Set result.field = source.

Method Summary

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

RECURSE

public static final CopyType RECURSE

Standard behavior: apply standard copier to the value of the field. This is the same thing that happens if the field is not annotated.

IDENTITY

public static final CopyType IDENTITY

Set result.field = source.field without copying

NULL

public static final CopyType NULL

Set result.field = null or 0 according to type.

SOURCE

public static final CopyType SOURCE

Set result.field = source. Requires that the declared type of field is assignment compatible with the type of the object; that is, field.class.isAssignableFrom( this.class ).

RESULT

public static final CopyType RESULT

Set result.field = result. Requires that the declared type of field is assignment compatible with the type of the object; that is, field.class.isAssignableFrom( this.class ).

Method Detail

values

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

Returns:

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

valueOf

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