Package com.pd4ml.pdf.cos

Class COSObject

java.lang.Object

com.pd4ml.pdf.cos.COSBase

com.pd4ml.pdf.cos.COSObject

All Implemented Interfaces:

COSObjectable

public final class COSObject
extends COSBase

An indirect reference, i.e. the "12 0 R" that appears inside another object's value. This is a lazy proxy: dereferencing (getObject() / resolve()) asks the owning COSDocument to look up (and, for on-disk documents, parse on first touch) the object with this key.

Every navigation helper in COSDictionary, COSArray and the com.pd4ml.pdf.cos.path package calls resolve() automatically, so most application code never needs to touch this class directly.

Constructor Summary

Constructors

Constructor	Description
COSObject(COSDocument document, COSObjectKey key)
COSObject(COSDocument document, COSObjectKey key, COSBase value)	Direct constructor for an already-known target, useful when building a document in memory rather than parsing one from disk.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(ICOSVisitor<T> visitor)
boolean	equals(java.lang.Object other)
COSBase	getCOSObject()	COSObjectable identity: a raw COS node is its own COS representation.
COSDocument	getDocument()
COSObjectKey	getIndirectKey()
COSBase	getObject()	Resolves and returns the referenced object, never null (an unresolvable reference yields COSNull.NULL, matching the PDF spec's treatment of dangling references).
int	hashCode()
COSBase	resolve()	Resolves through a COSObject indirection; every other COS type is already "resolved" and simply returns itself.
java.lang.String	toString()

Methods inherited from class com.pd4ml.pdf.cos.COSBase

getGenerationNumber, getKey, getObjectNumber, isDirect, setKey

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

COSObject

public COSObject(COSDocument document,
                 COSObjectKey key)

COSObject

public COSObject(COSDocument document,
                 COSObjectKey key,
                 COSBase value)

Direct constructor for an already-known target, useful when building a document in memory rather than parsing one from disk.

Method Detail

getIndirectKey

public COSObjectKey getIndirectKey()

getDocument

public COSDocument getDocument()

getObject

public COSBase getObject()

Resolves and returns the referenced object, never null (an unresolvable reference yields COSNull.NULL, matching the PDF spec's treatment of dangling references).

resolve

public COSBase resolve()

Description copied from class: COSBase

Resolves through a COSObject indirection; every other COS type is already "resolved" and simply returns itself. Parsers and the COSPathEvaluator call this after every navigation step so callers never have to special-case indirect references.

Overrides:

resolve in class COSBase

getCOSObject

public COSBase getCOSObject()

Description copied from class: COSBase

COSObjectable identity: a raw COS node is its own COS representation.

Specified by:

getCOSObject in interface COSObjectable

Overrides:

getCOSObject in class COSBase

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

accept

public <T> T accept(ICOSVisitor<T> visitor)
             throws COSException

Specified by:

accept in class COSBase

Throws:

COSException