Package org.apache.pdfbox.cos

Class COSInteger

java.lang.Object

org.apache.pdfbox.cos.COSBase

org.apache.pdfbox.cos.COSNumber

org.apache.pdfbox.cos.COSInteger

All Implemented Interfaces:

COSObjectable

public final class COSInteger
extends COSNumber

This class represents an integer number in a PDF document.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	HIGH	The highest integer to be kept in the STATIC array.
private final boolean	isValid
private static final int	LOW	The lowest integer to be kept in the STATIC array.
static final COSInteger	ONE	Constant for the number one.
protected static final COSInteger	OUT_OF_RANGE_MAX	Constant for an out of range value which is bigger than Log.MAX_VALUE.
protected static final COSInteger	OUT_OF_RANGE_MIN	Constant for an out of range value which is smaller than Log.MIN_VALUE.
private static final COSInteger[]	STATIC	Static instances of all COSIntegers in the range from LOW to HIGH.
static final COSInteger	THREE	Constant for the number three.
static final COSInteger	TWO	Constant for the number two.
private final long	value
static final COSInteger	ZERO	Constant for the number zero.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	COSInteger(long val, boolean valid)	constructor.

Method Summary

Modifier and Type	Method	Description
Object	accept(ICOSVisitor visitor)	visitor pattern double dispatch method.
double	doubleValue()	Deprecated. will be removed in a future release
boolean	equals(Object o)
float	floatValue()	polymorphic access to value as float.
static COSInteger	get(long val)	Returns a COSInteger instance with the given value.
private static COSInteger	getInvalid(boolean maxValue)
int	hashCode()
int	intValue()	Polymorphic access to value as int This will get the integer value of this object.
boolean	isValid()	Indicates whether this instance represents a valid value.
long	longValue()	Polymorphic access to value as int This will get the integer value of this object.
String	toString()
void	writePDF(OutputStream output)	This will output this string as a PDF object.

Methods inherited from class org.apache.pdfbox.cos.COSNumber

get

Methods inherited from class org.apache.pdfbox.cos.COSBase

getCOSObject, isDirect, setDirect

Methods inherited from class java.lang.Object

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

Field Details

LOW

private static final int LOW

The lowest integer to be kept in the STATIC array.

See Also:

• Constant Field Values

HIGH

private static final int HIGH

The highest integer to be kept in the STATIC array.

See Also:

• Constant Field Values

STATIC

private static final COSInteger[] STATIC

Static instances of all COSIntegers in the range from LOW to HIGH.

ZERO

public static final COSInteger ZERO

Constant for the number zero.

Since:

Apache PDFBox 1.1.0

ONE

public static final COSInteger ONE

Constant for the number one.

Since:

Apache PDFBox 1.1.0

TWO

public static final COSInteger TWO

Constant for the number two.

Since:

Apache PDFBox 1.1.0

THREE

public static final COSInteger THREE

Constant for the number three.

Since:

Apache PDFBox 1.1.0

OUT_OF_RANGE_MAX

protected static final COSInteger OUT_OF_RANGE_MAX

Constant for an out of range value which is bigger than Log.MAX_VALUE.

OUT_OF_RANGE_MIN

protected static final COSInteger OUT_OF_RANGE_MIN

Constant for an out of range value which is smaller than Log.MIN_VALUE.

value

private final long value

isValid

private final boolean isValid

Constructor Details

COSInteger

private COSInteger(long val,
 boolean valid)

constructor.

Parameters:

val - The integer value of this object.

Method Details

get

public static COSInteger get(long val)

Returns a COSInteger instance with the given value.

Parameters:

val - integer value

Returns:

COSInteger instance

getInvalid

private static COSInteger getInvalid(boolean maxValue)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

floatValue

public float floatValue()

polymorphic access to value as float.

Specified by:

floatValue in class COSNumber

Returns:

The float value of this object.

doubleValue

public double doubleValue()

Deprecated.

will be removed in a future release

polymorphic access to value as float.

Specified by:

doubleValue in class COSNumber

Returns:

The double value of this object.

intValue

public int intValue()

Polymorphic access to value as int This will get the integer value of this object.

Specified by:

intValue in class COSNumber

Returns:

The int value of this object,

longValue

public long longValue()

Polymorphic access to value as int This will get the integer value of this object.

Specified by:

longValue in class COSNumber

Returns:

The int value of this object,

isValid

public boolean isValid()

Indicates whether this instance represents a valid value.

Returns:

true if the value is valid

accept

public Object accept(ICOSVisitor visitor)
              throws IOException

visitor pattern double dispatch method.

Specified by:

accept in class COSBase

Parameters:

visitor - The object to notify when visiting this object.

Returns:

any object, depending on the visitor implementation, or null

Throws:

IOException - If an error occurs while visiting this object.

writePDF

public void writePDF(OutputStream output)
              throws IOException

This will output this string as a PDF object.

Parameters:

output - The stream to write to.

Throws:

IOException - If there is an error writing to the stream.