Apache PDFBox 3.0.4 · org.apache.pdfbox.cos.COSInteger

Modifier and Type	Field and 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.
public 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`.
public static final COSInteger	THREE Constant for the number three.
public static final COSInteger	TWO Constant for the number two.
private final long	value
public static final COSInteger	ZERO Constant for the number zero.

Access	Constructor and Description
private	COSInteger(long The integer value of this object. val, boolean indicates if the value is valid. valid) constructor.

Method Summary

Modifier and Type	Method and Description
public void	accept(ICOSVisitor The object to notify when visiting this object. visitor) Implements abstract org.apache.pdfbox.cos.COSBase.accept. visitor pattern double dispatch method.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public float	Returns: The float value of this object. floatValue() Implements abstract org.apache.pdfbox.cos.COSNumber.floatValue. polymorphic access to value as float.
public static COSInteger	Returns: COSInteger instance get(long integer value val) Returns a COSInteger instance with the given value.
private static COSInteger	getInvalid(boolean maxValue)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: The int value of this object, intValue() Implements abstract org.apache.pdfbox.cos.COSNumber.intValue. Polymorphic access to value as int This will get the integer value of this object.
public boolean	Returns: true if the value is valid isValid() Indicates whether this instance represents a valid value.
public long	Returns: The int value of this object, longValue() Implements abstract org.apache.pdfbox.cos.COSNumber.longValue. Polymorphic access to value as int This will get the integer value of this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writePDF(OutputStream The stream to write to. output) This will output this string as a PDF object.

Inherited from org.apache.pdfbox.cos.COSNumber:: get

Field Detail

HIGH	back to summary
private static final int HIGH The highest integer to be kept in the `STATIC` array.

isValid	back to summary
private final boolean isValid

LOW	back to summary
private static final int LOW The lowest integer to be kept in the `STATIC` array.

ONE	back to summary
public static final COSInteger ONE Constant for the number one. Since Apache PDFBox 1.1.0

ONE

back to summary

public static final COSInteger ONE

Constant for the number one.

Since: Apache PDFBox 1.1.0

OUT_OF_RANGE_MAX	back to summary
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	back to summary
protected static final COSInteger OUT_OF_RANGE_MIN Constant for an out of range value which is smaller than Log.MIN_VALUE.

STATIC	back to summary
private static final COSInteger[] STATIC Static instances of all COSIntegers in the range from `LOW` to `HIGH`.

THREE	back to summary
public static final COSInteger THREE Constant for the number three. Since Apache PDFBox 1.1.0

THREE

back to summary

public static final COSInteger THREE

Constant for the number three.

Since: Apache PDFBox 1.1.0

TWO	back to summary
public static final COSInteger TWO Constant for the number two. Since Apache PDFBox 1.1.0

TWO

back to summary

public static final COSInteger TWO

Constant for the number two.

Since: Apache PDFBox 1.1.0

value	back to summary
private final long value

ZERO	back to summary
public static final COSInteger ZERO Constant for the number zero. Since Apache PDFBox 1.1.0

ZERO

back to summary

public static final COSInteger ZERO

Constant for the number zero.

Since: Apache PDFBox 1.1.0

Constructor Detail

COSInteger	back to summary
private COSInteger(long val, boolean valid) constructor. Parameters val:long The integer value of this object. valid:boolean indicates if the value is valid.

COSInteger

back to summary

private COSInteger(long val, boolean valid)

constructor.

Parameters

val:long: The integer value of this object.
valid:boolean: indicates if the value is valid.

Method Detail

accept	back to summary
public void accept(ICOSVisitor visitor) throws IOException Implements abstract org.apache.pdfbox.cos.COSBase.accept. visitor pattern double dispatch method. Parameters visitor:ICOSVisitor The object to notify when visiting this object. Annotations @Override Exceptions IOException: If an error occurs while visiting this object.

back to summary

public void accept(ICOSVisitor visitor) throws IOException

Implements abstract org.apache.pdfbox.cos.COSBase.accept.

visitor pattern double dispatch method.

Parameters

visitor:ICOSVisitor: The object to notify when visiting this object.

Annotations

@Override

Exceptions

IOException:: If an error occurs while visiting this object.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

floatValue	back to summary
public float floatValue() Implements abstract org.apache.pdfbox.cos.COSNumber.floatValue. polymorphic access to value as float. Returns:float The float value of this object. Annotations @Override

floatValue

back to summary

public float floatValue()

Implements abstract org.apache.pdfbox.cos.COSNumber.floatValue.

polymorphic access to value as float.

Returns:float

The float value of this object.

Annotations

@Override

get	back to summary
public static COSInteger get(long val) Returns a COSInteger instance with the given value. Parameters val:long integer value Returns:COSInteger COSInteger instance

get

back to summary

public static COSInteger get(long val)

Returns a COSInteger instance with the given value.

Parameters

val:long: integer value

Returns:COSInteger

COSInteger instance

getInvalid	back to summary
private static COSInteger getInvalid(boolean maxValue)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

intValue	back to summary
public int intValue() Implements abstract org.apache.pdfbox.cos.COSNumber.intValue. Polymorphic access to value as int This will get the integer value of this object. Returns:int The int value of this object, Annotations @Override

intValue

back to summary

public int intValue()

Implements abstract org.apache.pdfbox.cos.COSNumber.intValue.

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

Returns:int

The int value of this object,

Annotations

@Override

isValid	back to summary
public boolean isValid() Indicates whether this instance represents a valid value. Returns:boolean true if the value is valid

isValid

back to summary

public boolean isValid()

Indicates whether this instance represents a valid value.

Returns:boolean: true if the value is valid

longValue	back to summary
public long longValue() Implements abstract org.apache.pdfbox.cos.COSNumber.longValue. Polymorphic access to value as int This will get the integer value of this object. Returns:long The int value of this object, Annotations @Override

longValue

back to summary

public long longValue()

Implements abstract org.apache.pdfbox.cos.COSNumber.longValue.

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

Returns:long

The int value of this object,

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

writePDF	back to summary
public void writePDF(OutputStream output) throws IOException This will output this string as a PDF object. Parameters output:OutputStream The stream to write to. Exceptions IOException: If there is an error writing to the stream.

writePDF

back to summary

public void writePDF(OutputStream output) throws IOException

This will output this string as a PDF object.

Parameters

output:OutputStream: The stream to write to.

Exceptions

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

public final Class COSInteger

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail