gnu.apdf

Class PDFInfo

java.lang.Object

gnu.apdf.PDFObject

gnu.apdf.PDFInfo

All Implemented Interfaces:

Serializable

public class PDFInfo
extends PDFObject

This class stores details of the author, the PDF generator etc. The values are accessible via the PDFDocument class.

Author:

Peter T. Mount, Eric Z. Beard, ericzbeard@hotmail.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PDFInfo() This constructs a minimal info object
PDFInfo(String title)

Method Summary

Modifier and Type	Method and Description
String	getAuthor() Get the value of author.
String	getCreator() PDF has two values, a Creator and a Producer.
String	getKeywords() Get the value of keywords.
String	getSubject() Get the value of subject.
String	getTitle() Get the value of title.
void	setAuthor(String v) Set the value of author.
void	setCreator(String v) Set the value of creator.
void	setKeywords(String v) Set the value of keywords.
void	setSubject(String v) Set the value of subject.
void	setTitle(String v) Set the value of title.
void	write(OutputStream os) Writes the object to the output stream.

Methods inherited from class gnu.apdf.PDFObject

getGeneration, getName, getPDFDocument, getSerialID, getType, setName, toArray, toString, writeEnd, writeStart

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFInfo

public PDFInfo()

This constructs a minimal info object

PDFInfo

public PDFInfo(String title)

Parameters:

title - Title of this document

Method Detail

getAuthor

public String getAuthor()

Get the value of author.

Returns:

value of author.

setAuthor

public void setAuthor(String v)

Set the value of author.

Parameters:

v - Value to assign to author.

getCreator

public String getCreator()

PDF has two values, a Creator and a Producer. The creator field is available for calling code. The producer is fixed by this library. Get the value of creator.

Returns:

value of creator.

setCreator

public void setCreator(String v)

Set the value of creator.

Parameters:

v - Value to assign to creator.

getTitle

public String getTitle()

Get the value of title.

Returns:

value of title.

setTitle

public void setTitle(String v)

Set the value of title.

Parameters:

v - Value to assign to title.

getSubject

public String getSubject()

Get the value of subject.

Returns:

value of subject.

setSubject

public void setSubject(String v)

Set the value of subject.

Parameters:

v - Value to assign to subject.

getKeywords

public String getKeywords()

Get the value of keywords.

Returns:

value of keywords.

setKeywords

public void setKeywords(String v)

Set the value of keywords.

Parameters:

v - Value to assign to keywords.

write

public void write(OutputStream os)
           throws IOException

Description copied from class: PDFObject

Writes the object to the output stream. This method must be overidden.

Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine.

Specified by:

write in class PDFObject

Parameters:

os - OutputStream to send the object to

Throws:

IOException - on error