org.sejda.model.toc

Enum ToCPolicy

java.lang.Object

java.lang.Enum<ToCPolicy>

org.sejda.model.toc.ToCPolicy

All Implemented Interfaces:

Serializable, Comparable<ToCPolicy>, FriendlyNamed

public enum ToCPolicy
extends Enum<ToCPolicy>
implements FriendlyNamed

Possible ToC creation policies to use in tasks that may require a ToC

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOC_TITLES
FILE_NAMES
NONE

Method Summary

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

NONE

public static final ToCPolicy NONE

FILE_NAMES

public static final ToCPolicy FILE_NAMES

DOC_TITLES

public static final ToCPolicy DOC_TITLES

Method Detail

values

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

Returns:

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

valueOf

public static ToCPolicy valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FriendlyNamed

Returns:

the friendly name of the entity, to be usually used as a representation for an user.