Package eu.europa.esig.dss.enumerations

Enum Class PdfLockAction

java.lang.Object

java.lang.Enum<PdfLockAction>

eu.europa.esig.dss.enumerations.PdfLockAction

All Implemented Interfaces:

Serializable, Comparable<PdfLockAction>, Constable

public enum PdfLockAction
extends Enum<PdfLockAction>

A name which, in conjunction with Fields, indicates the set of fields that should be locked.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All form fields do not permit changes
EXCLUDE	Only those form fields not specified in fields do not permit changes
INCLUDE	Only those form fields specified in fields do not permit changes

Method Summary

Modifier and Type	Method	Description
static PdfLockAction	forName(String name)	Returns a Action corresponding to the given name
String	getName()	Returns name value of the field parameter
static PdfLockAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PdfLockAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final PdfLockAction ALL

All form fields do not permit changes

INCLUDE

public static final PdfLockAction INCLUDE

Only those form fields specified in fields do not permit changes

EXCLUDE

public static final PdfLockAction EXCLUDE

Only those form fields not specified in fields do not permit changes

Method Details

values

public static PdfLockAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PdfLockAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Returns name value of the field parameter

Returns:

String

forName

public static PdfLockAction forName(String name)

Returns a Action corresponding to the given name

Parameters:

name - String

Returns:

PdfLockAction