org.apache.pdfbox.cos
Class COSBase

java.lang.Object
  extended by 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.

Version:
$Revision: 1.14 $
Author:
Ben Litchfield

Constructor Summary
COSBase()
           
 
Method Summary
abstract  java.lang.Object accept(ICOSVisitor visitor)
          visitor pattern double dispatch method.
 COSBase getCOSObject()
          Convert this standard java object to a COS object.
 FilterManager getFilterManager()
          This will get the filter manager to use to filter streams.
 boolean isDirect()
          If the state is set true, the dictionary will be written direct into the called object.
 boolean isNeedToBeUpdate()
           
 void setDirect(boolean direct)
          Set the state true, if the dictionary should be written as a direct object and not indirect.
 void setNeedToBeUpdate(boolean flag)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

COSBase

public COSBase()
Method Detail

getFilterManager

public FilterManager getFilterManager()
This will get the filter manager to use to filter streams.

Returns:
The filter manager.

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 java.lang.Object accept(ICOSVisitor visitor)
                                 throws COSVisitorException
visitor pattern double dispatch method.

Parameters:
visitor - The object to notify when visiting this object.
Returns:
any object, depending on the visitor implementation, or null
Throws:
COSVisitorException - If an error occurs while visiting this object.

setNeedToBeUpdate

public void setNeedToBeUpdate(boolean flag)

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 writting direct object

isNeedToBeUpdate

public boolean isNeedToBeUpdate()