com.datalogics.PDFL

Enum Inclusion

java.lang.Object

java.lang.Enum<Inclusion>

com.datalogics.PDFL.Inclusion

All Implemented Interfaces:

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

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

Specifies how to include a resource in a file.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static Inclusion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Inclusion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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