Package com.datalogics.PDFL

Enum Class Inclusion

java.lang.Object

java.lang.Enum<Inclusion>

com.datalogics.PDFL.Inclusion

All Implemented Interfaces:

Serializable, Comparable<Inclusion>, Constable

public enum Inclusion
extends Enum<Inclusion>

Specifies how to include a resource in a file.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BY_RANGE
NEVER	Never include the resource.
ON_EVERY_PAGE	Include the resource on every page in the file.
ONCE_PER_DOCUMENT	Include the resource only once per file.
WHEN_NEEDED	When needed.

Method Summary

Modifier and Type	Method	Description
static Inclusion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Inclusion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONCE_PER_DOCUMENT

public static final Inclusion ONCE_PER_DOCUMENT

Include the resource only once per file.

ON_EVERY_PAGE

public static final Inclusion ON_EVERY_PAGE

Include the resource on every page in the file.

NEVER

public static final Inclusion NEVER

Never include the resource.

WHEN_NEEDED

public static final Inclusion WHEN_NEEDED

When needed.

BY_RANGE

public static final Inclusion BY_RANGE

Method Details

values

public static Inclusion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Inclusion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null