org.apache.pdfbox.pdmodel.graphics.optionalcontent
Enum PDOptionalContentProperties.BaseState

java.lang.Object
  java.lang.Enum<PDOptionalContentProperties.BaseState>
      org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState

All Implemented Interfaces:

Serializable, Comparable<PDOptionalContentProperties.BaseState>

Enclosing class:

PDOptionalContentProperties

public static enum PDOptionalContentProperties.BaseState
extends Enum<PDOptionalContentProperties.BaseState>

Enumeration for the BaseState dictionary entry on the "D" dictionary.

Enum Constant Summary

OFF
The "OFF" value.

ON
The "ON" value.

UNCHANGED
The "Unchanged" value.

Method Summary

COSName	getName() Returns the PDF name for the state.
static PDOptionalContentProperties.BaseState	valueOf(COSName state) Returns the base state represented by the given COSName.
static PDOptionalContentProperties.BaseState	valueOf(String name) Returns the enum constant of this type with the specified name.
static PDOptionalContentProperties.BaseState[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ON

public static final PDOptionalContentProperties.BaseState ON

The "ON" value.

OFF

public static final PDOptionalContentProperties.BaseState OFF

The "OFF" value.

UNCHANGED

public static final PDOptionalContentProperties.BaseState UNCHANGED

The "Unchanged" value.

Method Detail

values

public static final PDOptionalContentProperties.BaseState[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PDOptionalContentProperties.BaseState c : PDOptionalContentProperties.BaseState.values())
        System.out.println(c);

Returns:

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

valueOf

public static PDOptionalContentProperties.BaseState 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

getName

public COSName getName()

Returns the PDF name for the state.

Returns:

the name of the state

valueOf

public static PDOptionalContentProperties.BaseState valueOf(COSName state)

Returns the base state represented by the given COSName.

Parameters:

state - the state name

Returns:

the state enum value