intarsys PDF library API

de.intarsys.pdf.cos
Interface ICOSObjectVisitor

All Known Implementing Classes:
COSObjectWalkerDeep, COSObjectWalkerShallow, COSWriter

public interface ICOSObjectVisitor

An interface for visiting a COS object structure.


Method Summary
 Object visitFromArray(COSArray array)
          Notification of visit to COSArray object.
 Object visitFromBoolean(COSBoolean bool)
          Notification of visit to COSBoolean object.
 Object visitFromDictionary(COSDictionary dict)
          Notification of visit to COSDictionary object.
 Object visitFromFixed(COSFixed fixed)
          Notification of visit to COSFixed object.
 Object visitFromIndirectObject(COSIndirectObject indirect)
          Notification of visit to COSIndirectObject object.
 Object visitFromInteger(COSInteger integer)
          Notification of visit to COSInteger object.
 Object visitFromName(COSName name)
          Notification of visit to COSName object.
 Object visitFromNull(COSNull nullObj)
          Notification of visit to COSNull object.
 Object visitFromStream(COSStream stream)
          Notification of visit to COSStream object.
 Object visitFromString(COSString string)
          Notification of visit to COSString object.
 

Method Detail

visitFromArray

Object visitFromArray(COSArray array)
                      throws COSVisitorException
Notification of visit to COSArray object.

Parameters:
array - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromBoolean

Object visitFromBoolean(COSBoolean bool)
                        throws COSVisitorException
Notification of visit to COSBoolean object.

Parameters:
bool - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromDictionary

Object visitFromDictionary(COSDictionary dict)
                           throws COSVisitorException
Notification of visit to COSDictionary object.

Parameters:
dict - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromFixed

Object visitFromFixed(COSFixed fixed)
                      throws COSVisitorException
Notification of visit to COSFixed object.

Parameters:
fixed - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromInteger

Object visitFromInteger(COSInteger integer)
                        throws COSVisitorException
Notification of visit to COSInteger object.

Parameters:
integer - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromName

Object visitFromName(COSName name)
                     throws COSVisitorException
Notification of visit to COSName object.

Parameters:
name - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromNull

Object visitFromNull(COSNull nullObj)
                     throws COSVisitorException
Notification of visit to COSNull object.

Parameters:
nullObj - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromStream

Object visitFromStream(COSStream stream)
                       throws COSVisitorException
Notification of visit to COSStream object.

Parameters:
stream - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromString

Object visitFromString(COSString string)
                       throws COSVisitorException
Notification of visit to COSString object.

Parameters:
string - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

visitFromIndirectObject

Object visitFromIndirectObject(COSIndirectObject indirect)
                               throws COSVisitorException
Notification of visit to COSIndirectObject object.

Parameters:
indirect - The Object that is being visited.
Returns:
any Object depending on the visitor implementation, or null
Throws:
COSVisitorException - If there is an error while visiting this object.

intarsys PDF library API

Copyright © 2006 intarsys consulting GmbH. All Rights Reserved.