Package org.apache.pdfbox.cos
Class COSObject
- java.lang.Object
-
- org.apache.pdfbox.cos.COSBase
-
- org.apache.pdfbox.cos.COSObject
-
- All Implemented Interfaces:
COSObjectable
public class COSObject extends COSBase
This class represents a PDF object.- Version:
- $Revision: 1.37 $
- Author:
- Ben Litchfield
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
accept(ICOSVisitor visitor)
visitor pattern double dispatch method.COSBase
getDictionaryObject(COSName key)
This will get the dictionary object in this object that has the name key and if it is a pdfobjref then it will dereference that and return it.COSInteger
getGenerationNumber()
Getter for property generationNumber.COSBase
getItem(COSName key)
This will get the dictionary object in this object that has the name key.COSBase
getObject()
This will get the object that this object encapsulates.COSInteger
getObjectNumber()
Getter for property objectNumber.void
setGenerationNumber(COSInteger generationNumberValue)
Setter for property generationNumber.void
setObject(COSBase object)
This will set the object that this object encapsulates.void
setObjectNumber(COSInteger objectNum)
Setter for property objectNumber.java.lang.String
toString()
-
Methods inherited from class org.apache.pdfbox.cos.COSBase
getCOSObject, getFilterManager, isDirect, isNeedToBeUpdate, setDirect, setNeedToBeUpdate
-
-
-
-
Constructor Detail
-
COSObject
public COSObject(COSBase object) throws java.io.IOException
Constructor.- Parameters:
object
- The object that this encapsulates.- Throws:
java.io.IOException
- If there is an error with the object passed in.
-
-
Method Detail
-
getDictionaryObject
public COSBase getDictionaryObject(COSName key)
This will get the dictionary object in this object that has the name key and if it is a pdfobjref then it will dereference that and return it.- Parameters:
key
- The key to the value that we are searching for.- Returns:
- The pdf object that matches the key.
-
getItem
public COSBase getItem(COSName key)
This will get the dictionary object in this object that has the name key.- Parameters:
key
- The key to the value that we are searching for.- Returns:
- The pdf object that matches the key.
-
getObject
public COSBase getObject()
This will get the object that this object encapsulates.- Returns:
- The encapsulated object.
-
setObject
public void setObject(COSBase object) throws java.io.IOException
This will set the object that this object encapsulates.- Parameters:
object
- The new object to encapsulate.- Throws:
java.io.IOException
- If there is an error setting the updated object.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getObjectNumber
public COSInteger getObjectNumber()
Getter for property objectNumber.- Returns:
- Value of property objectNumber.
-
setObjectNumber
public void setObjectNumber(COSInteger objectNum)
Setter for property objectNumber.- Parameters:
objectNum
- New value of property objectNumber.
-
getGenerationNumber
public COSInteger getGenerationNumber()
Getter for property generationNumber.- Returns:
- Value of property generationNumber.
-
setGenerationNumber
public void setGenerationNumber(COSInteger generationNumberValue)
Setter for property generationNumber.- Parameters:
generationNumberValue
- New value of property generationNumber.
-
accept
public java.lang.Object accept(ICOSVisitor visitor) throws COSVisitorException
visitor pattern double dispatch method.- Specified by:
accept
in classCOSBase
- 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.
-
-