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
This class represents an integer number in a PDF document.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
The highest integer to be kept in theSTATIC
array.private final boolean
private static final int
The lowest integer to be kept in theSTATIC
array.static final COSInteger
Constant for the number one.protected static final COSInteger
Constant for an out of range value which is bigger than Log.MAX_VALUE.protected static final COSInteger
Constant for an out of range value which is smaller than Log.MIN_VALUE.private static final COSInteger[]
static final COSInteger
Constant for the number three.static final COSInteger
Constant for the number two.private final long
static final COSInteger
Constant for the number zero. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccept
(ICOSVisitor visitor) visitor pattern double dispatch method.double
Deprecated.will be removed in a future releaseboolean
float
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
Polymorphic access to value as int This will get the integer value of this object.toString()
void
writePDF
(OutputStream output) This will output this string as a PDF object.Methods inherited from class org.apache.pdfbox.cos.COSBase
getCOSObject, isDirect, setDirect
-
Field Details
-
LOW
private static final int LOWThe lowest integer to be kept in theSTATIC
array.- See Also:
-
HIGH
private static final int HIGHThe highest integer to be kept in theSTATIC
array.- See Also:
-
STATIC
-
ZERO
Constant for the number zero.- Since:
- Apache PDFBox 1.1.0
-
ONE
Constant for the number one.- Since:
- Apache PDFBox 1.1.0
-
TWO
Constant for the number two.- Since:
- Apache PDFBox 1.1.0
-
THREE
Constant for the number three.- Since:
- Apache PDFBox 1.1.0
-
OUT_OF_RANGE_MAX
Constant for an out of range value which is bigger than Log.MAX_VALUE. -
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
Returns a COSInteger instance with the given value.- Parameters:
val
- integer value- Returns:
- COSInteger instance
-
getInvalid
-
equals
-
hashCode
public int hashCode() -
toString
-
floatValue
public float floatValue()polymorphic access to value as float.- Specified by:
floatValue
in classCOSNumber
- Returns:
- The float value of this object.
-
doubleValue
public double doubleValue()Deprecated.will be removed in a future releasepolymorphic access to value as float.- Specified by:
doubleValue
in classCOSNumber
- 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. -
longValue
public long longValue()Polymorphic access to value as int This will get the integer value of this object. -
isValid
public boolean isValid()Indicates whether this instance represents a valid value.- Returns:
- true if the value is valid
-
accept
visitor pattern double dispatch method.- Specified by:
accept
in classCOSBase
- 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
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.
-