org.sejda.model.watermark

Enum Location

java.lang.Object

java.lang.Enum<Location>

org.sejda.model.watermark.Location

All Implemented Interfaces:

Serializable, Comparable<Location>, FriendlyNamed

public enum Location
extends Enum<Location>
implements FriendlyNamed

Locations where the watermark can appear relative to the page content

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEHIND
OVER

Method Summary

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

BEHIND

public static final Location BEHIND

OVER

public static final Location OVER

Method Detail

values

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

Returns:

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

valueOf

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