DocumentInfo (Qoppa jPDFPrint API)

java.lang.Object
- com.qoppa.pdf.DocumentInfo

```
public abstract class DocumentInfo
extends Object
```
This class is a container for the information section of a PDF document. This section contains fields such as author, title, subject, keywords, etc.

Author:

Qoppa Software

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AUTHOR`
`static String`	`KEY_CREATIONDATE`
`static String`	`KEY_CREATOR`
`static String`	`KEY_KEYWORDS`
`static String`	`KEY_MODDATE`
`static String`	`KEY_PRODUCER`
`static String`	`KEY_SUBJECT`
`static String`	`KEY_TITLE`
`static String`	`KEY_TRAPPED`

Constructor Summary

Constructors
Constructor and Description

DocumentInfo()

Constructors
Constructor and Description
`DocumentInfo()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract String`	`getAuthor()` Returns the document's author.
`abstract String`	`getAuthorTitle()` Returns the document's author-title.
`abstract String`	`getCopyrightInfoURL()` Returns the document's copyright info url.
`abstract String`	`getCopyrightNotice()` Returns the document's copyright notice.
`abstract String`	`getCopyrightStatus()` Returns the document's copyrights status.
`abstract Date`	`getCreationDate()` Returns the document's creation date.
`abstract String`	`getCreator()` Returns the document's creator.
`abstract String`	`getCustomProperty(String key)` Returns the value of a custom property.
`abstract String`	`getDescriptionWriter()` Returns the document's description writer.
`static DocumentInfo`	`getDocumentInfo(InputStream inStream, IPassword password)` Static method to get the document information from a document from an InputStream.
`static DocumentInfo`	`getDocumentInfo(String fileName, IPassword passwords)` Static method to get the document information from a document in a file.
`static DocumentInfo`	`getDocumentInfo(URL url, IPassword password)` Static method to get the document information from a document from a URL.
`abstract String`	`getKeywords()` Returns the document's keywords.
`abstract Date`	`getModDate()` Returns the document's modified date.
`abstract int`	`getPageCount()` Gets the number of pages in the document.
`abstract String`	`getProducer()` Returns the document's producer.
`abstract String`	`getSubject()` Returns the document's subject.
`abstract String`	`getTitle()` Gets the document's title.
`abstract String`	`getTrapped()` Returns string indicating if the document has been modified with trapping information.
`abstract byte[]`	`getXMPMetadata()` Returns the raw XMP metadata in the document as an array of bytes.
`abstract String`	`getXMPMetadata(String charsetName)` Returns the XMP metadata in the document.
`abstract void`	`setAuthor(String author)` Set the document's author.
`abstract void`	`setAuthorTitle(String authorTitle)` Set the document's author-title.
`abstract void`	`setCopyrightInfoURL(String copyrightURL)` Set the document's copyright info url.
`abstract void`	`setCopyrightNotice(String copyrightNotice)` Set the document's copyright notice.
`abstract void`	`setCopyrightStatus(String copyrightStatus)` Set the document's copyrights status.
`abstract void`	`setCreationDate(Date creationDate)` Set the document's creation date.
`abstract void`	`setCreator(String creator)` Set the document's creator.
`abstract void`	`setCustomProperty(String key, String value)` Sets a custom application property in the document info for the document.
`abstract void`	`setDescriptionWriter(String descriptionWriter)` Set the document's description writer.
`abstract void`	`setKeywords(String keywords)` Set the document's keywords.
`abstract void`	`setModifiedDate(Date modDate)` Deprecated. The document's modified date will be set by the library at the time the document is saved.
`abstract void`	`setProducer(String producer)` Set the document's producer.
`abstract void`	`setSubject(String subject)` Set the document's subject.
`abstract void`	`setTitle(String title)` Sets the document's title.
`abstract void`	`setXMPMetadata(byte[] xmpData)` Sets the XMP metadata block in the document.
`abstract void`	`setXMPMetadata(String xmpString, String charsetName)` Sets the XMP metadata block in the document.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_TITLE
```
public static final String KEY_TITLE
```
    See Also:
    
    Constant Field Values
  - KEY_AUTHOR
```
public static final String KEY_AUTHOR
```
    See Also:
    
    Constant Field Values
  - KEY_SUBJECT
```
public static final String KEY_SUBJECT
```
    See Also:
    
    Constant Field Values
  - KEY_KEYWORDS
```
public static final String KEY_KEYWORDS
```
    See Also:
    
    Constant Field Values
  - KEY_CREATOR
```
public static final String KEY_CREATOR
```
    See Also:
    
    Constant Field Values
  - KEY_PRODUCER
```
public static final String KEY_PRODUCER
```
    See Also:
    
    Constant Field Values
  - KEY_TRAPPED
```
public static final String KEY_TRAPPED
```
    See Also:
    
    Constant Field Values
  - KEY_CREATIONDATE
```
public static final String KEY_CREATIONDATE
```
    See Also:
    
    Constant Field Values
  - KEY_MODDATE
```
public static final String KEY_MODDATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DocumentInfo
```
public DocumentInfo()
```
- Method Detail
  - getDocumentInfo
```
public static DocumentInfo getDocumentInfo(String fileName,
                                           IPassword passwords)
                                    throws PDFException
```
    Static method to get the document information from a document in a file.
    
    Parameters:
    
    fileName - The name of the file.
    
    passwords - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Returns:
    
    A DocumentInfo object containing the PDF document's header information.
    
    Throws:
    
    PDFException - Thrown when any error occurs when getting the document info from the PDF document.
  - getDocumentInfo
```
public static DocumentInfo getDocumentInfo(InputStream inStream,
                                           IPassword password)
                                    throws PDFException
```
    Static method to get the document information from a document from an InputStream.
    
    Parameters:
    
    inStream - InputStream that will be used to read the PDF document.
    
    password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Returns:
    
    A DocumentInfo object containing the PDF document's header information.
    
    Throws:
    
    PDFException - Thrown when any error occurs when getting the document info from the PDF document.
  - getDocumentInfo
```
public static DocumentInfo getDocumentInfo(URL url,
                                           IPassword password)
                                    throws PDFException
```
    Static method to get the document information from a document from a URL.
    
    Parameters:
    
    url - The url where the PDF document can be found.
    
    password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Returns:
    
    A DocumentInfo object containing the PDF document's header information.
    
    Throws:
    
    PDFException - Thrown when any error occurs when getting the document info from the PDF document.
  - getTitle
```
public abstract String getTitle()
```
    Gets the document's title.
    
    Returns:
    
    The document title.
  - setTitle
```
public abstract void setTitle(String title)
                       throws PDFException
```
    Sets the document's title.
    
    Parameters:
    
    title - The document's title.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the title property inside the PDF.
  - getAuthor
```
public abstract String getAuthor()
```
    Returns the document's author.
    
    Returns:
    
    The document's author.
  - getSubject
```
public abstract String getSubject()
```
    Returns the document's subject.
    
    Returns:
    
    The document's subject.
  - getKeywords
```
public abstract String getKeywords()
```
    Returns the document's keywords.
    
    Returns:
    
    The document's keywords.
  - getCreator
```
public abstract String getCreator()
```
    Returns the document's creator. Many applications will display this field as the "Application" in their document info dialog.
    
    Returns:
    
    The document's creator.
  - getProducer
```
public abstract String getProducer()
```
    Returns the document's producer.
    
    Returns:
    
    The document's producer.
  - getTrapped
```
public abstract String getTrapped()
```
    Returns string indicating if the document has been modified with trapping information.
    
    Returns:
    
    The document trapping string.
  - getCreationDate
```
public abstract Date getCreationDate()
```
    Returns the document's creation date.
    
    Returns:
    
    The document's creation date.
  - getModDate
```
public abstract Date getModDate()
```
    Returns the document's modified date.
    
    Returns:
    
    The document's modified date.
  - getPageCount
```
public abstract int getPageCount()
```
    Gets the number of pages in the document.
    
    Returns:
    
    Number of pages.
  - setAuthor
```
public abstract void setAuthor(String author)
                        throws PDFException
```
    Set the document's author.
    
    Parameters:
    
    author - The document's author.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the author property inside the PDF.
  - setCreationDate
```
public abstract void setCreationDate(Date creationDate)
                              throws PDFException
```
    Set the document's creation date.
    
    Parameters:
    
    creationDate - The document's creation date.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the creation date property inside the PDF.
  - setCreator
```
public abstract void setCreator(String creator)
                         throws PDFException
```
    Set the document's creator. Many applications will display this field as the "Application" in their document info dialog.
    
    Parameters:
    
    creator - The document's creator.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the creator property inside the PDF.
  - setKeywords
```
public abstract void setKeywords(String keywords)
                          throws PDFException
```
    Set the document's keywords.
    
    Parameters:
    
    keywords - The document's keywords.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the keywords property inside the PDF.
  - setModifiedDate
```
public abstract void setModifiedDate(Date modDate)
                              throws PDFException
```
    Deprecated. The document's modified date will be set by the library at the time the document is saved.
    
    Set the document's modified date.
    
    Parameters:
    
    modDate - The document's modified date.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the modified date property inside the PDF.
  - setProducer
```
public abstract void setProducer(String producer)
                          throws PDFException
```
    Set the document's producer.
    
    Parameters:
    
    producer - The document's producer.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the producer property inside the PDF.
  - setSubject
```
public abstract void setSubject(String subject)
                         throws PDFException
```
    Set the document's subject.
    
    Parameters:
    
    subject - The document's subject.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the subject inside the PDF.
  - getXMPMetadata
```
public abstract String getXMPMetadata(String charsetName)
                               throws UnsupportedEncodingException
```
    Returns the XMP metadata in the document.
    
    Parameters:
    
    charsetName - The name of the character set to use when decoding the XMP data stream. Every implementation of Java is supposed to support US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE and UTF-16
    
    Returns:
    
    the XMP metadata, as a String holding XML data.
    
    Throws:
    
    UnsupportedEncodingException - Thrown if the character set name specified is not available in this JVM.
  - setXMPMetadata
```
public abstract void setXMPMetadata(String xmpString,
                                    String charsetName)
                             throws PDFException,
                                    UnsupportedEncodingException
```
    Sets the XMP metadata block in the document. The xmpString should be properly formatted XMP XML data.
    
    Parameters:
    
    xmpString - The new XMP block.
    
    charsetName - The name of the character set to use when encoding the XMP string to bytes. Every implementation of Java is supposed to support US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE and UTF-16
    
    xmpString - The new XMP metadata. The new data will replace any existing XMP metadata if there is any.
    
    charsetName - The character set to use when writing the XMP metadata to the PDF file.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the XMP metadata inside the PDF.
    
    UnsupportedEncodingException - Thrown if the character set name specified is not available in this JVM.
  - setXMPMetadata
```
public abstract void setXMPMetadata(byte[] xmpData)
                             throws PDFException
```
    Sets the XMP metadata block in the document. The xmpData should already be encoded in the desired encoding, this method simply puts the bytes directly into the PDF document.
    
    Parameters:
    
    xmpData - The new XMP metadata. The new data will replace any existing XMP metadata if there is any.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the XMP metadata inside the PDF.
  - getXMPMetadata
```
public abstract byte[] getXMPMetadata()
```
    Returns the raw XMP metadata in the document as an array of bytes.
    
    Returns:
    
    the XMP metadata, as an array of bytes holding XML data.
  - setCustomProperty
```
public abstract void setCustomProperty(String key,
                                       String value)
                                throws PDFException
```
    Sets a custom application property in the document info for the document. The PDF format allows for applications setting their own properties, but it is up to the application to make sure that these properties do not conflict with standard properties.
    
    Parameters:
    
    key - The property key or name
    
    value - The value of the property.
    
    Throws:
    
    PDFException - Thrown when any error occurs when setting the custom property inside the PDF.
  - getCustomProperty
```
public abstract String getCustomProperty(String key)
```
    Returns the value of a custom property. The PDF format allows for applications setting their own properties, but it is up to the application to make sure that these properties do not conflict with standard properties.
    
    Parameters:
    
    key - The name of the property
    
    Returns:
    
    the value of the custom property
  - setAuthorTitle
```
public abstract void setAuthorTitle(String authorTitle)
```
    Set the document's author-title.
    
    Parameters:
    
    authorTitle - The document's author-title.
  - getAuthorTitle
```
public abstract String getAuthorTitle()
```
    Returns the document's author-title.
    
    Returns:
    
    The document's author-title.
  - setDescriptionWriter
```
public abstract void setDescriptionWriter(String descriptionWriter)
```
    Set the document's description writer.
    
    Parameters:
    
    descriptionWriter - The document's description writer.
  - getDescriptionWriter
```
public abstract String getDescriptionWriter()
```
    Returns the document's description writer.
    
    Returns:
    
    The document's description writer.
  - setCopyrightStatus
```
public abstract void setCopyrightStatus(String copyrightStatus)
```
    Set the document's copyrights status. Should be null if unknown, "False" if Public Domain, and "True" if copyrighted.
    
    Parameters:
    
    copyrightStatus - The document's copyrights status.
  - getCopyrightStatus
```
public abstract String getCopyrightStatus()
```
    Returns the document's copyrights status.
    
    Returns:
    
    The document's copyrights status - null if unknown, "False" if Public Domain, and "True" if copyrighted.
  - setCopyrightInfoURL
```
public abstract void setCopyrightInfoURL(String copyrightURL)
```
    Set the document's copyright info url.
    
    Parameters:
    
    copyrightURL - The document's copyright info url.
  - getCopyrightInfoURL
```
public abstract String getCopyrightInfoURL()
```
    Returns the document's copyright info url.
    
    Returns:
    
    The document's copyright info url.
  - setCopyrightNotice
```
public abstract void setCopyrightNotice(String copyrightNotice)
```
    Set the document's copyright notice.
    
    Parameters:
    
    copyrightNotice - The document's copyright notice.
  - getCopyrightNotice
```
public abstract String getCopyrightNotice()
```
    Returns the document's copyright notice.
    
    Returns:
    
    The document's copyright notice.

Class DocumentInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_TITLE

KEY_AUTHOR

KEY_SUBJECT

KEY_KEYWORDS

KEY_CREATOR

KEY_PRODUCER

KEY_TRAPPED

KEY_CREATIONDATE

KEY_MODDATE

Constructor Detail

DocumentInfo

Method Detail

getDocumentInfo

getDocumentInfo

getDocumentInfo

getTitle

setTitle

getAuthor

getSubject

getKeywords

getCreator

getProducer

getTrapped

getCreationDate

getModDate

getPageCount

setAuthor

setCreationDate

setCreator

setKeywords

setModifiedDate

setProducer

setSubject

getXMPMetadata

setXMPMetadata

setXMPMetadata

getXMPMetadata

setCustomProperty

getCustomProperty

setAuthorTitle

getAuthorTitle

setDescriptionWriter

getDescriptionWriter

setCopyrightStatus

getCopyrightStatus

setCopyrightInfoURL

getCopyrightInfoURL

setCopyrightNotice

getCopyrightNotice