Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.PDDocumentInformation

Modifier and Type	Field and Description
private final COSDictionary	info

Access	Constructor and Description
public	PDDocumentInformation() Default Constructor.
public	PDDocumentInformation(COSDictionary The underlying dictionary. dic) Constructor that is used for a preexisting dictionary.

Method Summary

Modifier and Type	Method and Description
public String	Returns: The author of the document. getAuthor() This will get the author of the document.
public COSDictionary	Returns: The underlying info dictionary. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. This will get the underlying dictionary that this object wraps.
public Calendar	Returns: The creation date of the document. getCreationDate() This will get the creation date of the document.
public String	Returns: The creator of the document. getCreator() This will get the creator of the document.
public String	Returns: String Value of metadata field getCustomMetadataValue(String Name of custom metadata field from pdf document. fieldName) This will get the value of a custom metadata information field for the document.
public String	Returns: The keywords of the document. getKeywords() This will get the keywords of the document.
public Set<String>	Returns: all metadata key strings. getMetadataKeys() This will get the keys of all metadata information fields for the document.
public Calendar	Returns: The modification date of the document. getModificationDate() This will get the modification date of the document.
public String	Returns: The producer of the document. getProducer() This will get the producer of the document.
public Object	Returns: the properties value getPropertyStringValue(String the dictionaries key propertyKey) Return the properties String value.
public String	Returns: The subject of the document. getSubject() This will get the subject of the document.
public String	Returns: The title of the document. getTitle() This will get the title of the document.
public String	Returns: The trapped value for the document. getTrapped() This will get the trapped value for the document.
public void	setAuthor(String The new author for the document. author) This will set the author of the document.
public void	setCreationDate(Calendar The new creation date for the document. date) This will set the creation date of the document.
public void	setCreator(String The new creator for the document. creator) This will set the creator of the document.
public void	setCustomMetadataValue(String The name of the custom metadata field. fieldName, String The value to the custom metadata field. fieldValue) Set the custom metadata value.
public void	setKeywords(String The new keywords for the document. keywords) This will set the keywords of the document.
public void	setModificationDate(Calendar The new modification date for the document. date) This will set the modification date of the document.
public void	setProducer(String The new producer for the document. producer) This will set the producer of the document.
public void	setSubject(String The new subject for the document. subject) This will set the subject of the document.
public void	setTitle(String The new title for the document. title) This will set the title of the document.
public void	setTrapped(String The new trapped value for the document. value) This will set the trapped of the document.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

info	back to summary
private final COSDictionary info

PDDocumentInformation	back to summary
public PDDocumentInformation() Default Constructor.

PDDocumentInformation	back to summary
public PDDocumentInformation(COSDictionary dic) Constructor that is used for a preexisting dictionary. Parameters dic:COSDictionary The underlying dictionary.

Method Detail

getAuthor	back to summary
public String getAuthor() This will get the author of the document. This will return null if no author exists. Returns:String The author of the document.

getAuthor

back to summary

public String getAuthor()

This will get the author of the document. This will return null if no author exists.

Returns:String: The author of the document.

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. This will get the underlying dictionary that this object wraps. Returns:COSDictionary The underlying info dictionary. Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

This will get the underlying dictionary that this object wraps.

Returns:COSDictionary

The underlying info dictionary.

Annotations

@Override

getCreationDate	back to summary
public Calendar getCreationDate() This will get the creation date of the document. This will return null if no creation date exists. Returns:Calendar The creation date of the document.

getCreationDate

back to summary

public Calendar getCreationDate()

This will get the creation date of the document. This will return null if no creation date exists.

Returns:Calendar: The creation date of the document.

getCreator	back to summary
public String getCreator() This will get the creator of the document. This will return null if no creator exists. Returns:String The creator of the document.

getCreator

back to summary

public String getCreator()

This will get the creator of the document. This will return null if no creator exists.

Returns:String: The creator of the document.

getCustomMetadataValue

back to summary

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.

Parameters

fieldName:String: Name of custom metadata field from pdf document.

Returns:String

String Value of metadata field

getKeywords	back to summary
public String getKeywords() This will get the keywords of the document. This will return null if no keywords exists. Returns:String The keywords of the document.

getKeywords

back to summary

public String getKeywords()

This will get the keywords of the document. This will return null if no keywords exists.

Returns:String: The keywords of the document.

getMetadataKeys

back to summary

public Set<String> getMetadataKeys()

This will get the keys of all metadata information fields for the document.

Returns:Set<String>: all metadata key strings.
Since: Apache PDFBox 1.3.0

getModificationDate	back to summary
public Calendar getModificationDate() This will get the modification date of the document. This will return null if no modification date exists. Returns:Calendar The modification date of the document.

getModificationDate

back to summary

public Calendar getModificationDate()

This will get the modification date of the document. This will return null if no modification date exists.

Returns:Calendar: The modification date of the document.

getProducer	back to summary
public String getProducer() This will get the producer of the document. This will return null if no producer exists. Returns:String The producer of the document.

getProducer

back to summary

public String getProducer()

This will get the producer of the document. This will return null if no producer exists.

Returns:String: The producer of the document.

getPropertyStringValue	back to summary
public Object getPropertyStringValue(String propertyKey) Return the properties String value. Allows to retrieve the low level date for validation purposes. Parameters propertyKey:String the dictionaries key Returns:Object the properties value

getPropertyStringValue

back to summary

public Object getPropertyStringValue(String propertyKey)

Return the properties String value.

Allows to retrieve the low level date for validation purposes.

Parameters

propertyKey:String: the dictionaries key

Returns:Object

the properties value

getSubject	back to summary
public String getSubject() This will get the subject of the document. This will return null if no subject exists. Returns:String The subject of the document.

getSubject

back to summary

public String getSubject()

This will get the subject of the document. This will return null if no subject exists.

Returns:String: The subject of the document.

getTitle	back to summary
public String getTitle() This will get the title of the document. This will return null if no title exists. Returns:String The title of the document.

getTitle

back to summary

public String getTitle()

This will get the title of the document. This will return null if no title exists.

Returns:String: The title of the document.

getTrapped	back to summary
public String getTrapped() This will get the trapped value for the document. This will return null if one is not found. Returns:String The trapped value for the document.

getTrapped

back to summary

public String getTrapped()

This will get the trapped value for the document. This will return null if one is not found.

Returns:String: The trapped value for the document.

setAuthor	back to summary
public void setAuthor(String author) This will set the author of the document. Parameters author:String The new author for the document.

setAuthor

back to summary

public void setAuthor(String author)

This will set the author of the document.

Parameters

author:String: The new author for the document.

setCreationDate	back to summary
public void setCreationDate(Calendar date) This will set the creation date of the document. Parameters date:Calendar The new creation date for the document.

setCreator	back to summary
public void setCreator(String creator) This will set the creator of the document. Parameters creator:String The new creator for the document.

setCreator

back to summary

public void setCreator(String creator)

This will set the creator of the document.

Parameters

creator:String: The new creator for the document.

setCustomMetadataValue

back to summary

public void setCustomMetadataValue(String fieldName, String fieldValue)

Set the custom metadata value.

Parameters

fieldName:String: The name of the custom metadata field.
fieldValue:String: The value to the custom metadata field.

setKeywords	back to summary
public void setKeywords(String keywords) This will set the keywords of the document. Parameters keywords:String The new keywords for the document.

setKeywords

back to summary

public void setKeywords(String keywords)

This will set the keywords of the document.

Parameters

keywords:String: The new keywords for the document.

setModificationDate	back to summary
public void setModificationDate(Calendar date) This will set the modification date of the document. Parameters date:Calendar The new modification date for the document.

setProducer	back to summary
public void setProducer(String producer) This will set the producer of the document. Parameters producer:String The new producer for the document.

setProducer

back to summary

public void setProducer(String producer)

This will set the producer of the document.

Parameters

producer:String: The new producer for the document.

setSubject	back to summary
public void setSubject(String subject) This will set the subject of the document. Parameters subject:String The new subject for the document.

setSubject

back to summary

public void setSubject(String subject)

This will set the subject of the document.

Parameters

subject:String: The new subject for the document.

setTitle	back to summary
public void setTitle(String title) This will set the title of the document. Parameters title:String The new title for the document.

setTitle

back to summary

public void setTitle(String title)

This will set the title of the document.

Parameters

title:String: The new title for the document.

setTrapped	back to summary
public void setTrapped(String value) This will set the trapped of the document. This will be 'True', 'False', or 'Unknown'. Parameters value:String The new trapped value for the document. Exceptions IllegalArgumentException: if the parameter is invalid.

setTrapped

back to summary

public void setTrapped(String value)

This will set the trapped of the document. This will be 'True', 'False', or 'Unknown'.

Parameters

value:String: The new trapped value for the document.

Exceptions

IllegalArgumentException:: if the parameter is invalid.

public Class PDDocumentInformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail