Enum PDOptionalContentProperties.BaseState
- java.lang.Object
-
- java.lang.Enum<PDOptionalContentProperties.BaseState>
-
- org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PDOptionalContentProperties.BaseState>
- Enclosing class:
- PDOptionalContentProperties
public static enum PDOptionalContentProperties.BaseState extends java.lang.Enum<PDOptionalContentProperties.BaseState>
Enumeration for the BaseState dictionary entry on the "D" dictionary.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description COSName
getName()
Returns the PDF name for the state.static PDOptionalContentProperties.BaseState
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static PDOptionalContentProperties.BaseState
valueOf(COSName state)
Returns the base state represented by the givenCOSName
.static PDOptionalContentProperties.BaseState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
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.
-
-
Field Detail
-
name
private final COSName name
-
-
Constructor Detail
-
BaseState
private BaseState(COSName value)
-
-
Method Detail
-
values
public static PDOptionalContentProperties.BaseState[] 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 (PDOptionalContentProperties.BaseState c : PDOptionalContentProperties.BaseState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PDOptionalContentProperties.BaseState valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
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 givenCOSName
.- Parameters:
state
- the state name- Returns:
- the state enum value
-
-