Package org.apache.pdfbox.pdfparser.xref

Enum XReferenceType

java.lang.Object

java.lang.Enum<XReferenceType>

org.apache.pdfbox.pdfparser.xref.XReferenceType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XReferenceType>

public enum XReferenceType
extends java.lang.Enum<XReferenceType>

An instance of this class represents a type for a XReferenceEntry, as it can be found in a PDF's PDFXRefStream.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FREE
NORMAL
OBJECT_STREAM_ENTRY

Field Summary

Fields

Modifier and Type	Field	Description
private int	numericValue

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XReferenceType(int numericValue)	Represents a type for a XReferenceEntry, as it can be found in a PDF's PDFXRefStream.

Method Summary

Modifier and Type	Method	Description
int	getNumericValue()	Returns the numeric representation of this type.
static XReferenceType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static XReferenceType[]	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

FREE

public static final XReferenceType FREE

NORMAL

public static final XReferenceType NORMAL

OBJECT_STREAM_ENTRY

public static final XReferenceType OBJECT_STREAM_ENTRY

Field Detail

numericValue

private final int numericValue

Constructor Detail

XReferenceType

private XReferenceType(int numericValue)

Represents a type for a XReferenceEntry, as it can be found in a PDF's PDFXRefStream.

Parameters:

numericValue - The numeric representation of this type.

Method Detail

values

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

Returns:

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

valueOf

public static XReferenceType 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 name

java.lang.NullPointerException - if the argument is null

getNumericValue

public int getNumericValue()

Returns the numeric representation of this type.

Returns:

The numeric representation of this type.