org.icepdf.core.pobjects

Class PInfo

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.PInfo

public class PInfo
extends Dictionary

This class represents the data stored in a File trailers optional "info" entry.

Any entry whose value is not known should be omitted from the dictionary, rather than included with an empty string as its value.

Some plug-in extensions may choose to permit searches on the contents of the document information dictionary. To facilitate browsing and editing, all keys in the dictionary are fully spelled out, not abbreviated. New keys should be chosen with care so that they make sense to users.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
static Name	AUTHOR_KEY
static Name	CREATIONDATE_KEY
static Name	CREATOR_KEY
static Name	KEYWORDS_KEY
static Name	MODDATE_KEY
static Name	PRODUCER_KEY
static Name	RESOURCES_KEY
static Name	SUBJECT_KEY
static Name	TITLE_KEY
static Name	TRAPPED_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
PInfo(Library library, java.util.HashMap entries) Create a new instance of a PInfo object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthor() Gets the name of the person who created the document.
PDate	getCreationDate() Gets the date and time the document was created.
java.lang.String	getCreator() Gets the name of the application.
java.lang.Object	getCustomExtension(Name name) Gets the value of the custom extension specified by name.
java.lang.String	getKeywords() Gets the keywords associated with the document.
PDate	getModDate() Gets the date and time the document was most recently modified.
java.lang.String	getProducer() Gets the name of the application.
java.lang.String	getSubject() Gets the subject of the document.
java.lang.String	getTitle() Gets the title of the document.
java.lang.String	getTrappingInformation() Get the name object indicating whether the document has been modified to include trapping information: False - The document has not yet been trapped; any desired trapping must still be done. Unknown - (default) Either it is unknown whether the document has been trapped or it has been partly but not yet fully trapped; some additional trapping may still be needed.

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCES_KEY

public static final Name RESOURCES_KEY

TITLE_KEY

public static final Name TITLE_KEY

AUTHOR_KEY

public static final Name AUTHOR_KEY

SUBJECT_KEY

public static final Name SUBJECT_KEY

KEYWORDS_KEY

public static final Name KEYWORDS_KEY

CREATOR_KEY

public static final Name CREATOR_KEY

PRODUCER_KEY

public static final Name PRODUCER_KEY

CREATIONDATE_KEY

public static final Name CREATIONDATE_KEY

MODDATE_KEY

public static final Name MODDATE_KEY

TRAPPED_KEY

public static final Name TRAPPED_KEY

Constructor Detail

PInfo

public PInfo(Library library,
             java.util.HashMap entries)

Create a new instance of a PInfo object.

Parameters:

library - document library

entries - entries for this object dictionary.

Method Detail

getCustomExtension

public java.lang.Object getCustomExtension(Name name)

Gets the value of the custom extension specified by name.

Parameters:

name - som plug-in extensions name.

Returns:

value of the plug-in extension.

getTitle

public java.lang.String getTitle()

Gets the title of the document.

Returns:

the documents title.

getAuthor

public java.lang.String getAuthor()

Gets the name of the person who created the document.

Returns:

author name.

getSubject

public java.lang.String getSubject()

Gets the subject of the document.

Returns:

documents subject.

getKeywords

public java.lang.String getKeywords()

Gets the keywords associated with the document.

Returns:

documents keywords.

getCreator

public java.lang.String getCreator()

Gets the name of the application. If the PDF document was converted from another format that created the original document.

Returns:

creator name.

getProducer

public java.lang.String getProducer()

Gets the name of the application. If the PDF document was converted from another format that converted the original document.

Returns:

producer name.

getCreationDate

public PDate getCreationDate()

Gets the date and time the document was created.

Returns:

creation date.

getModDate

public PDate getModDate()

Gets the date and time the document was most recently modified.

Returns:

modification date.

getTrappingInformation

public java.lang.String getTrappingInformation()

Get the name object indicating whether the document has been modified to include trapping information:

• False - The document has not yet been trapped; any desired trapping must still be done.
• Unknown - (default) Either it is unknown whether the document has been trapped or it has been partly but not yet fully trapped; some additional trapping may still be needed.

Returns:

trapped name.