org.sejda.model.prefix

Enum Prefix

java.lang.Object

java.lang.Enum<Prefix>

org.sejda.model.prefix.Prefix

All Implemented Interfaces:

Serializable, Comparable<Prefix>, FriendlyNamed

public enum Prefix
extends Enum<Prefix>
implements FriendlyNamed

Enumerates the available complex prefixes that Sejda can handle. A prefix has a friendly name that can be used to build help message or UI menus.

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASENAME
BOOKMARK
BOOKMARK_STRICT
CURRENTPAGE
FILENUMBER
TIMESTAMP

Method Summary

Methods

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

BASENAME

public static final Prefix BASENAME

TIMESTAMP

public static final Prefix TIMESTAMP

CURRENTPAGE

public static final Prefix CURRENTPAGE

FILENUMBER

public static final Prefix FILENUMBER

BOOKMARK

public static final Prefix BOOKMARK

BOOKMARK_STRICT

public static final Prefix BOOKMARK_STRICT

Method Detail

values

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

Returns:

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

valueOf

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