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

Modifier and Type	Field and Description
private static final long	GENERATION_MASK
private static final int	NUMBER_OFFSET
private final long	numberAndGeneration
private final int	streamIndex

Access	Constructor and Description
public	COSObjectKey(long The object number. num, int The object generation number. gen) Constructor.
public	COSObjectKey(long The object number. num, int The object generation number. gen, int The index within a compressed object stream index) Constructor.

Modifier and Type	Method and Description
public int	compareTo(COSObjectKey the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public static final long	Returns: the internal hash for the given values computeInternalHash(long the object number num, int the generation number gen) Calculate the internal hash value for the given object number and generation number.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	Returns: The object generation number. getGeneration() This will get the object generation number.
public long	Returns: the internal hash value getInternalHash() Return the internal hash value which is based on the number and the generation.
public long	Returns: The object number. getNumber() This will get the object number.
public int	Returns: the index within a compressed object stream if applicable otherwise -1 getStreamIndex() The index within a compressed object stream.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

GENERATION_MASK	back to summary
private static final long GENERATION_MASK

NUMBER_OFFSET	back to summary
private static final int NUMBER_OFFSET

numberAndGeneration	back to summary
private final long numberAndGeneration

streamIndex	back to summary
private final int streamIndex

COSObjectKey	back to summary
public COSObjectKey(long num, int gen) Constructor. Parameters num:long The object number. gen:int The object generation number.

COSObjectKey	back to summary
public COSObjectKey(long num, int gen, int index) Constructor. Parameters num:long The object number. gen:int The object generation number. index:int The index within a compressed object stream

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(COSObjectKey other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:COSObjectKey the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(COSObjectKey other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:COSObjectKey: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

computeInternalHash	back to summary
public static final long computeInternalHash(long num, int gen) Calculate the internal hash value for the given object number and generation number. Parameters num:long the object number gen:int the generation number Returns:long the internal hash for the given values

computeInternalHash

back to summary

public static final long computeInternalHash(long num, int gen)

Calculate the internal hash value for the given object number and generation number.

Parameters

num:long: the object number
gen:int: the generation number

Returns:long

the internal hash for the given values

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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 obj: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 obj)

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

obj: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

getGeneration	back to summary
public int getGeneration() This will get the object generation number. Returns:int The object generation number.

getGeneration

back to summary

public int getGeneration()

This will get the object generation number.

Returns:int: The object generation number.

getInternalHash	back to summary
public long getInternalHash() Return the internal hash value which is based on the number and the generation. Returns:long the internal hash value

getInternalHash

back to summary

public long getInternalHash()

Return the internal hash value which is based on the number and the generation.

Returns:long: the internal hash value

getNumber	back to summary
public long getNumber() This will get the object number. Returns:long The object number.

getNumber

back to summary

public long getNumber()

This will get the object number.

Returns:long: The object number.

getStreamIndex	back to summary
public int getStreamIndex() The index within a compressed object stream. Returns:int the index within a compressed object stream if applicable otherwise -1

getStreamIndex

back to summary

public int getStreamIndex()

The index within a compressed object stream.

Returns:int: the index within a compressed object stream if applicable otherwise -1

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

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

public final Class COSObjectKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail