com.oracle.outsidein

Enum Callback.AssociationValue

java.lang.Object

java.lang.Enum<Callback.AssociationValue>

com.oracle.outsidein.Callback.AssociationValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Callback.AssociationValue>

Enclosing class:

Callback

public static enum Callback.AssociationValue
extends java.lang.Enum<Callback.AssociationValue>

Describes the relationship of a new file to the original destination file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD For new files (usually GIFs, JPEGs, or PNGs) that are embedded in the parent file.
COPY For files that are being copied as the result of a template copy macro.
REQUIREDNAME A valid Callback.CreateNewFileResponse object must be returned by Callback.createNewFile(FileFormat, FileFormat, AssociationValue, String).
ROOT The file to be created is the initial destination file.
SIBLING For new files that are not somehow owned by the parent file.

Method Summary

Methods

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

ROOT

public static final Callback.AssociationValue ROOT

The file to be created is the initial destination file.

SIBLING

public static final Callback.AssociationValue SIBLING

For new files that are not somehow owned by the parent file. For example, additional HTML output files created as the result of template directives.

CHILD

public static final Callback.AssociationValue CHILD

For new files (usually GIFs, JPEGs, or PNGs) that are embedded in the parent file.

COPY

public static final Callback.AssociationValue COPY

For files that are being copied as the result of a template copy macro. Callback.createNewFile(FileFormat, FileFormat, AssociationValue, String) must return null.

REQUIREDNAME

public static final Callback.AssociationValue REQUIREDNAME

A valid Callback.CreateNewFileResponse object must be returned by Callback.createNewFile(FileFormat, FileFormat, AssociationValue, String).

Method Detail

values

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

Returns:

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

valueOf

public static Callback.AssociationValue 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