Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdfwriter » [javadoc | source]
org.apache.pdfbox.pdfwriter
public class: COSWriterXRefEntry [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdfwriter.COSWriterXRefEntry

All Implemented Interfaces:
    Comparable

this is en entry in the xref section of the physical pdf document generated by the COSWriter.
Constructor:
 public COSWriterXRefEntry(long start,
    COSBase obj,
    COSObjectKey keyValue) 
    COSWriterXRefEntry constructor comment.
    Parameters:
    start - The start attribute.
    obj - The COS object that this entry represents.
    keyValue - The key to the COS object.
Method from org.apache.pdfbox.pdfwriter.COSWriterXRefEntry Summary:
compareTo,   getKey,   getObject,   getOffset,   isFree,   setFree,   setOffset
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdfwriter.COSWriterXRefEntry Detail:
 public int compareTo(Object obj) 
    {@inheritDoc}
 public COSObjectKey getKey() 
    This will get the Object key.
 public COSBase getObject() 
    This will get the object.
 public long getOffset() 
    This will get the offset into the document.
 public boolean isFree() 
    Gets the xref 'free' attribute.
 public  void setFree(boolean newFree) 
    This will set the free attribute.
 public  void setOffset(long newOffset) 
    The offset attribute.