org.sejda.model.outline

Enum OutlinePolicy

java.lang.Object

java.lang.Enum<OutlinePolicy>

org.sejda.model.outline.OutlinePolicy

All Implemented Interfaces:

Serializable, Comparable<OutlinePolicy>, FriendlyNamed

public enum OutlinePolicy
extends Enum<OutlinePolicy>
implements FriendlyNamed

Enumerates policies that a task can use to handle the outline tree. This is mostly relevant when merging documents but it can be used for other tasks as well.

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCARD
ONE_ENTRY_EACH_DOC
RETAIN
RETAIN_AS_ONE_ENTRY

Method Summary

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

DISCARD

public static final OutlinePolicy DISCARD

RETAIN

public static final OutlinePolicy RETAIN

ONE_ENTRY_EACH_DOC

public static final OutlinePolicy ONE_ENTRY_EACH_DOC

RETAIN_AS_ONE_ENTRY

public static final OutlinePolicy RETAIN_AS_ONE_ENTRY

Method Detail

values

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

Returns:

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

valueOf

public static OutlinePolicy 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.