Package org.apache.pdfbox.cos

Class COSBase

java.lang.Object

org.apache.pdfbox.cos.COSBase

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

COSArray, COSBoolean, COSDictionary, COSDocument, COSName, COSNull, COSNumber, COSObject, COSString

public abstract class COSBase
extends java.lang.Object
implements COSObjectable

The base object that all objects in the PDF document will extend.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	direct
private COSObjectKey	key

Constructor Summary

Constructors

Constructor	Description
COSBase()	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	accept(ICOSVisitor visitor)	visitor pattern double dispatch method.
COSBase	getCOSObject()	Convert this standard java object to a COS object.
COSObjectKey	getKey()	This will return the COSObjectKey of an indirect object.
boolean	isDirect()	If the state is set true, the dictionary will be written direct into the called object.
void	setDirect(boolean direct)	Set the state true, if the dictionary should be written as a direct object and not indirect.
void	setKey(COSObjectKey key)	Set the COSObjectKey of an indirect object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

direct

private boolean direct

key

private COSObjectKey key

Constructor Detail

COSBase

public COSBase()

Constructor.

Method Detail

getCOSObject

public COSBase getCOSObject()

Convert this standard java object to a COS object.

Specified by:

getCOSObject in interface COSObjectable

Returns:

The cos object that matches this Java object.

accept

public abstract void accept(ICOSVisitor visitor)
                     throws java.io.IOException

visitor pattern double dispatch method.

Parameters:

visitor - The object to notify when visiting this object.

Throws:

java.io.IOException - If an error occurs while visiting this object.

isDirect

public boolean isDirect()

If the state is set true, the dictionary will be written direct into the called object. This means, no indirect object will be created.

Returns:

the state

setDirect

public void setDirect(boolean direct)

Set the state true, if the dictionary should be written as a direct object and not indirect.

Parameters:

direct - set it true, for writing direct object

getKey

public COSObjectKey getKey()

This will return the COSObjectKey of an indirect object.

Returns:

the COSObjectKey

setKey

public void setKey(COSObjectKey key)

Set the COSObjectKey of an indirect object.

Parameters:

key - the COSObjectKey of the indirect object