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

All Implemented Interfaces:
    COSObjectable

This is the document metadata. Each getXXX method will return the entry if it exists or null if it does not exist. If you pass in null for the setXXX method then it will clear the value.
Constructor:
 public PDDocumentInformation() 
 public PDDocumentInformation(COSDictionary dic) 
    Constructor that is used for a preexisting dictionary.
    Parameters:
    dic - The underlying dictionary.
Method from org.apache.pdfbox.pdmodel.PDDocumentInformation Summary:
getAuthor,   getCOSObject,   getCreationDate,   getCreator,   getCustomMetadataValue,   getDictionary,   getKeywords,   getModificationDate,   getProducer,   getSubject,   getTitle,   getTrapped,   setAuthor,   setCreationDate,   setCreator,   setCustomMetadataValue,   setKeywords,   setModificationDate,   setProducer,   setSubject,   setTitle,   setTrapped
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.PDDocumentInformation Detail:
 public String getAuthor() 
    This will get the author of the document. This will return null if no author exists.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public Calendar getCreationDate() throws IOException 
    This will get the creation date of the document. This will return null if no creation date exists.
 public String getCreator() 
    This will get the creator of the document. This will return null if no creator exists.
 public String getCustomMetadataValue(String fieldName) 
    This will get the value of a custom metadata information field for the document. This will return null if one is not found.
 public COSDictionary getDictionary() 
    This will get the underlying dictionary that this object wraps.
 public String getKeywords() 
    This will get the keywords of the document. This will return null if no keywords exists.
 public Calendar getModificationDate() throws IOException 
    This will get the modification date of the document. This will return null if no modification date exists.
 public String getProducer() 
    This will get the producer of the document. This will return null if no producer exists.
 public String getSubject() 
    This will get the subject of the document. This will return null if no subject exists.
 public String getTitle() 
    This will get the title of the document. This will return null if no title exists.
 public String getTrapped() 
    This will get the trapped value for the document. This will return null if one is not found.
 public  void setAuthor(String author) 
    This will set the author of the document.
 public  void setCreationDate(Calendar date) 
    This will set the creation date of the document.
 public  void setCreator(String creator) 
    This will set the creator of the document.
 public  void setCustomMetadataValue(String fieldName,
    String fieldValue) 
    Set the custom metadata value.
 public  void setKeywords(String keywords) 
    This will set the keywords of the document.
 public  void setModificationDate(Calendar date) 
    This will set the modification date of the document.
 public  void setProducer(String producer) 
    This will set the producer of the document.
 public  void setSubject(String subject) 
    This will set the subject of the document.
 public  void setTitle(String title) 
    This will set the title of the document.
 public  void setTrapped(String value) 
    This will set the trapped of the document. This will be 'True', 'False', or 'Unknown'.