Uses of Class
org.apache.pdfbox.cos.COSObjectKey

Packages that use COSObjectKey

Package	Description
org.apache.pdfbox.cos	These are the low level objects that make up a PDF document.
org.apache.pdfbox.pdfparser	The pdfparser package contains classes to parse PDF documents and objects within the document.
org.apache.pdfbox.pdfparser.xref
org.apache.pdfbox.pdfwriter	This is the persistence layer used to write the PDFBox documents to a stream.
org.apache.pdfbox.pdfwriter.compress

Uses of COSObjectKey in org.apache.pdfbox.cos

Methods in org.apache.pdfbox.cos that return COSObjectKey

Modifier and Type	Method	Description
COSObjectKey	COSBase.getKey()	This will return the COSObjectKey of an indirect object.

Methods in org.apache.pdfbox.cos that return types with arguments of type COSObjectKey

Modifier and Type	Method	Description
Map<COSObjectKey,Long>	COSDocument.getXrefTable()	Returns the xrefTable which is a mapping of ObjectKeys to byte offsets in the file.
protected Collection<COSObjectKey>	COSArray.resetObjectKeys(Collection<COSObjectKey> indirectObjects)	Resets the object key of all indirect objects numbers within this array and all included dictionaries and arrays.
protected Collection<COSObjectKey>	COSDictionary.resetObjectKeys(Collection<COSObjectKey> indirectObjects)	Resets the object key of all indirect objects numbers within this dictionary and all included dictionaries and arrays.

Methods in org.apache.pdfbox.cos with parameters of type COSObjectKey

Modifier and Type	Method	Description
int	COSObjectKey.compareTo(COSObjectKey other)
COSObject	COSDocument.getObjectFromPool(COSObjectKey key)	This will get an object from the pool.
void	COSBase.setKey(COSObjectKey key)	Set the COSObjectKey of an indirect object.

Method parameters in org.apache.pdfbox.cos with type arguments of type COSObjectKey

Modifier and Type	Method	Description
void	COSDocument.addXRefTable(Map<COSObjectKey,Long> xrefTableValues)	Populate XRef HashMap with given values.
void	COSArray.getIndirectObjectKeys(Collection<COSObjectKey> indirectObjects)	Collects all indirect objects numbers within this COSArray and all included dictionaries.
void	COSArray.getIndirectObjectKeys(List<COSObjectKey> indirectObjects)	Collects all indirect objects numbers within this COSArray and all included dictionaries.
void	COSDictionary.getIndirectObjectKeys(Collection<COSObjectKey> indirectObjects)	Collects all indirect objects numbers within this dictionary and all included dictionaries.
void	COSDictionary.getIndirectObjectKeys(List<COSObjectKey> indirectObjects)	Collects all indirect objects numbers within this dictionary and all included dictionaries.
protected Collection<COSObjectKey>	COSArray.resetObjectKeys(Collection<COSObjectKey> indirectObjects)	Resets the object key of all indirect objects numbers within this array and all included dictionaries and arrays.
protected Collection<COSObjectKey>	COSDictionary.resetObjectKeys(Collection<COSObjectKey> indirectObjects)	Resets the object key of all indirect objects numbers within this dictionary and all included dictionaries and arrays.

Constructors in org.apache.pdfbox.cos with parameters of type COSObjectKey

Modifier	Constructor	Description
	COSObject(COSBase object, COSObjectKey objectKey)	Constructor.
	COSObject(COSObjectKey key, ICOSParser parser)	Constructor.

Uses of COSObjectKey in org.apache.pdfbox.pdfparser

Methods in org.apache.pdfbox.pdfparser that return COSObjectKey

Modifier and Type	Method	Description
protected COSObjectKey	BaseParser.getObjectKey(long num, int gen)	Returns the object key for the given combination of object and generation number.

Methods in org.apache.pdfbox.pdfparser that return types with arguments of type COSObjectKey

Modifier and Type	Method	Description
protected Map<COSObjectKey,Long>	BruteForceParser.getBFCOSObjectOffsets()	Returns all found objects of a brute force search.
Map<COSObjectKey,Long>	XrefTrailerResolver.getXrefTable()	Gets the resolved xref table.
Map<COSObjectKey,COSBase>	PDFObjectStreamParser.parseAllObjects()	Parse all compressed objects.

Methods in org.apache.pdfbox.pdfparser with parameters of type COSObjectKey

Modifier and Type	Method	Description
protected COSBase	COSParser.parseObjectDynamically(COSObjectKey objKey, boolean requireExistingNotCompressedObj)	Parse the object for the given object key.
protected COSBase	COSParser.parseObjectStreamObject(long objstmObjNr, COSObjectKey key)	Parse the object with the given key from the object stream with the given number.
void	XrefTrailerResolver.setXRef(COSObjectKey objKey, long offset)	Populate XRef HashMap of current XRef object.

Uses of COSObjectKey in org.apache.pdfbox.pdfparser.xref

Methods in org.apache.pdfbox.pdfparser.xref that return COSObjectKey

Modifier and Type	Method	Description
COSObjectKey	ObjectStreamXReference.getParentKey()	Returns the COSObjectKey of the object stream, that is containing the object.
COSObjectKey	FreeXReference.getReferencedKey()	Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
COSObjectKey	NormalXReference.getReferencedKey()	Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
COSObjectKey	ObjectStreamXReference.getReferencedKey()	Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
COSObjectKey	XReferenceEntry.getReferencedKey()	Returns the COSObjectKey of the object, that is described by this crossreference stream entry.

Constructors in org.apache.pdfbox.pdfparser.xref with parameters of type COSObjectKey

Modifier	Constructor	Description
	FreeXReference(COSObjectKey key, long nextFreeObject)	Sets the given COSObjectKey as a free reference in a PDF's crossreference stream (PDFXRefStream).
	NormalXReference(long byteOffset, COSObjectKey key, COSBase object)	Prepares a normal reference for the given COSObject in a PDF's crossreference stream (PDFXRefStream).
	ObjectStreamXReference(int objectStreamIndex, COSObjectKey key, COSBase object, COSObjectKey parentKey)	Prepares a object stream entry reference for the given COSObject in a PDF's crossreference stream (PDFXRefStream).

Uses of COSObjectKey in org.apache.pdfbox.pdfwriter

Methods in org.apache.pdfbox.pdfwriter with parameters of type COSObjectKey

Modifier and Type	Method	Description
void	COSWriter.doWriteObject(COSObjectKey key, COSBase obj)	This will write a COS object for a predefined key.

Uses of COSObjectKey in org.apache.pdfbox.pdfwriter.compress

Methods in org.apache.pdfbox.pdfwriter.compress that return COSObjectKey

Modifier and Type	Method	Description
COSObjectKey	COSObjectPool.getKey(COSBase object)	Returns the COSObjectKey for a given registered COSBase.
COSObjectKey	COSWriterCompressionPool.getKey(COSBase object)	Returns the COSObjectKey, that is registered for the given COSBase in this compression pool.
COSObjectKey	COSObjectPool.put(COSObjectKey key, COSBase object)	Update the key and object maps.

Methods in org.apache.pdfbox.pdfwriter.compress that return types with arguments of type COSObjectKey

Modifier and Type	Method	Description
List<COSObjectKey>	COSWriterCompressionPool.getObjectStreamObjects()	Returns all COSBases that can be appended to an object stream.
List<COSObjectKey>	COSWriterObjectStream.getPreparedKeys()	Returns all COSObjectKeys, that shall be added to the object stream, when COSWriterObjectStream.writeObjectsToStream(COSStream) is called.
List<COSObjectKey>	COSWriterCompressionPool.getTopLevelObjects()	Returns all COSBases, that must be added to the document's top level container.

Methods in org.apache.pdfbox.pdfwriter.compress with parameters of type COSObjectKey

Modifier and Type	Method	Description
boolean	COSObjectPool.contains(COSObjectKey key)	Returns true, if a COSBase is registered for the given COSObjectKey.
COSBase	COSObjectPool.getObject(COSObjectKey key)	Returns the COSBase, that is registered for the given COSObjectKey, or null if no object is registered for that key.
COSBase	COSWriterCompressionPool.getObject(COSObjectKey key)	Returns the COSBase, that is registered for the given COSObjectKey in this compression pool.
void	COSWriterObjectStream.prepareStreamObject(COSObjectKey key, COSBase object)	Prepares the given COSObject to be written to this object stream, using the given COSObjectKey as it's ID for indirect references.
COSObjectKey	COSObjectPool.put(COSObjectKey key, COSBase object)	Update the key and object maps.