com.itextpdf.kernel.pdf

Class PdfNumber

java.lang.Object

com.itextpdf.kernel.pdf.PdfObject

com.itextpdf.kernel.pdf.PdfPrimitiveObject

com.itextpdf.kernel.pdf.PdfNumber

public class PdfNumber
extends PdfPrimitiveObject

A PdfNumber-class is the PDF-equivalent of a Double-object.

PDF provides two types of numeric objects: integer and real. Integer objects represent mathematical integers. Real objects represent mathematical real numbers. The range and precision of numbers may be limited by the internal representations used in the computer on which the PDF processor is running. An integer shall be written as one or more decimal digits optionally preceded by a sign. The value shall be interpreted as a signed decimal integer and shall be converted to an integer object. A real value shall be written as one or more decimal digits with an optional sign and a leading, trailing, or embedded period (decimal point).

Field Summary

Fields inherited from class com.itextpdf.kernel.pdf.PdfPrimitiveObject

content, directOnly

Fields inherited from class com.itextpdf.kernel.pdf.PdfObject

ARRAY, BOOLEAN, DICTIONARY, FLUSHED, FORBID_RELEASE, FREE, INDIRECT_REFERENCE, indirectReference, LITERAL, MODIFIED, MUST_BE_FLUSHED, MUST_BE_INDIRECT, NAME, NULL, NUMBER, ORIGINAL_OBJECT_STREAM, READ_ONLY, READING, STREAM, STRING, UNENCRYPTED

Constructor Summary

Constructors

Constructor and Description
PdfNumber(byte[] content) Creates an instance of PdfNumber with provided content.
PdfNumber(double value) Creates an instance of PdfNumber and sets value.
PdfNumber(int value) Creates an instance of PdfNumber and sets value.

Method Summary

Modifier and Type	Method and Description
protected void	copyContent(PdfObject from, PdfDocument document, ICopyFilter copyFilter) Copies object content from object 'from'.
void	decrement() Decrements current value.
double	doubleValue() Returns double value of current instance of PdfNumber.
boolean	equals(Object o)
float	floatValue() Returns value and converts it to float.
protected void	generateContent()
protected void	generateValue()
byte	getType() Gets object type.
double	getValue() Returns value of current instance of PdfNumber.
boolean	hasDecimalPoint() Checks if string representation of the value contains decimal point.
int	hashCode()
void	increment() Increments current value.
int	intValue() Returns value and converts it to an int.
protected boolean	isDoubleNumber()
long	longValue() Returns value and converts it to long.
protected PdfObject	newInstance() Creates new instance of object.
void	setValue(double value) Sets value.
void	setValue(int value) Sets value and convert it to double.
String	toString()

Methods inherited from class com.itextpdf.kernel.pdf.PdfPrimitiveObject

compareContent, getInternalContent, hasContent, makeIndirect, setIndirectReference

Methods inherited from class com.itextpdf.kernel.pdf.PdfObject

checkState, clearState, clone, clone, copyContent, copyTo, copyTo, copyTo, copyTo, flush, flush, getIndirectReference, isArray, isBoolean, isDictionary, isFlushed, isIndirect, isIndirectReference, isLiteral, isModified, isName, isNull, isNumber, isReleaseForbidden, isStream, isString, makeIndirect, release, setModified, setState

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfNumber

public PdfNumber(double value)

Creates an instance of PdfNumber and sets value.

Parameters:

value - double value to set

PdfNumber

public PdfNumber(int value)

Creates an instance of PdfNumber and sets value.

Parameters:

value - int value to set

PdfNumber

public PdfNumber(byte[] content)

Creates an instance of PdfNumber with provided content.

Parameters:

content - byte array content to set

Method Detail

getType

public byte getType()

Description copied from class: PdfObject

Gets object type.

Specified by:

getType in class PdfObject

Returns:

object type.

getValue

public double getValue()

Returns value of current instance of PdfNumber.

Returns:

value of PdfNumber instance

doubleValue

public double doubleValue()

Returns double value of current instance of PdfNumber.

Returns:

double value of PdfNumber instance

floatValue

public float floatValue()

Returns value and converts it to float.

Returns:

value converted to float

longValue

public long longValue()

Returns value and converts it to long.

Returns:

value converted to long

intValue

public int intValue()

Returns value and converts it to an int. If value surpasses Integer.MAX_VALUE, Integer.MAX_VALUE would be return.

Returns:

value converted to int

setValue

public void setValue(int value)

Sets value and convert it to double.

Parameters:

value - to set

setValue

public void setValue(double value)

Sets value.

Parameters:

value - to set

increment

public void increment()

Increments current value.

decrement

public void decrement()

Decrements current value.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hasDecimalPoint

public boolean hasDecimalPoint()

Checks if string representation of the value contains decimal point.

Returns:

true if contains so the number must be real not integer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

newInstance

protected PdfObject newInstance()

Description copied from class: PdfObject

Creates new instance of object.

Specified by:

newInstance in class PdfObject

Returns:

new instance of object.

isDoubleNumber

protected boolean isDoubleNumber()

generateContent

protected void generateContent()

Specified by:

generateContent in class PdfPrimitiveObject

generateValue

protected void generateValue()

copyContent

protected void copyContent(PdfObject from,
                           PdfDocument document,
                           ICopyFilter copyFilter)

Description copied from class: PdfObject

Copies object content from object 'from'.

Overrides:

copyContent in class PdfPrimitiveObject

Parameters:

from - object to copy content from.

document - document to copy object to.

copyFilter - ICopyFilter a filter that will apply on dictionaries and array Use NullCopyFilter for no filtering