Package org.apache.pdfbox.cos
Class COSObject
- java.lang.Object
-
- org.apache.pdfbox.cos.COSBase
-
- org.apache.pdfbox.cos.COSObject
-
- All Implemented Interfaces:
COSUpdateInfo
,COSObjectable
public class COSObject extends COSBase implements COSUpdateInfo
This class represents a PDF object.
-
-
Field Summary
Fields Modifier and Type Field Description private COSBase
baseObject
private int
generationNumber
private boolean
needToBeUpdated
private long
objectNumber
-
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.int
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.long
getObjectNumber()
Getter for property objectNumber.boolean
isNeedToBeUpdated()
Get the update state for the COSWriter.void
setGenerationNumber(int generationNumberValue)
Setter for property generationNumber.void
setNeedToBeUpdated(boolean flag)
Set the update state of the dictionary for the COSWriter.void
setObject(COSBase object)
This will set the object that this object encapsulates.void
setObjectNumber(long objectNum)
Setter for property objectNumber.java.lang.String
toString()
-
Methods inherited from class org.apache.pdfbox.cos.COSBase
getCOSObject, isDirect, setDirect
-
-
-
-
Field Detail
-
baseObject
private COSBase baseObject
-
objectNumber
private long objectNumber
-
generationNumber
private int generationNumber
-
needToBeUpdated
private boolean needToBeUpdated
-
-
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 final 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 long getObjectNumber()
Getter for property objectNumber.- Returns:
- Value of property objectNumber.
-
setObjectNumber
public void setObjectNumber(long objectNum)
Setter for property objectNumber.- Parameters:
objectNum
- New value of property objectNumber.
-
getGenerationNumber
public int getGenerationNumber()
Getter for property generationNumber.- Returns:
- Value of property generationNumber.
-
setGenerationNumber
public void setGenerationNumber(int generationNumberValue)
Setter for property generationNumber.- Parameters:
generationNumberValue
- New value of property generationNumber.
-
accept
public java.lang.Object accept(ICOSVisitor visitor) throws java.io.IOException
visitor pattern double dispatch method.
-
isNeedToBeUpdated
public boolean isNeedToBeUpdated()
Get the update state for the COSWriter.- Specified by:
isNeedToBeUpdated
in interfaceCOSUpdateInfo
- Returns:
- the update state.
-
setNeedToBeUpdated
public void setNeedToBeUpdated(boolean flag)
Set the update state of the dictionary for the COSWriter.- Specified by:
setNeedToBeUpdated
in interfaceCOSUpdateInfo
- Parameters:
flag
- the update state.
-
-