com.adobe.livecycle.xmputility.client
Class XMPUtilityMetadata

java.lang.Object
  com.adobe.livecycle.xmputility.client.XMPUtilityMetadata

All Implemented Interfaces:

java.io.Serializable

public class XMPUtilityMetadata
extends java.lang.Object
implements java.io.Serializable

Represents metadata values that can be imported into a PDF document or exported from a PDF document. Using this object, you can define the following metadata values:

• Author
• Title
• Subject
• Keywords
• Creator
• Producer

A null value in this object represents missing entries in the metadata. That is, if you invoke the ImportMetadata method with an XMPUtilityMetadata object that contains all null values, all those entries are removed from the metadata.

See Also:

importMetadata(), Serialized Form

Constructor Summary

XMPUtilityMetadata()
A constructor that creates a XMPUtilityMetadata instance.

Method Summary

java.lang.String	getAuthor() Gets the author value.
java.lang.String	getCreator() Gets the creator value.
java.util.List	getKeywords() Gets a list of keyword values.
java.lang.String	getProducer() Gets a producer value.
java.lang.String	getSubject() Gets a subject value.
java.lang.String	getTitle() Gets a title value.
void	setAuthor(java.lang.String author) Sets the author value.
void	setCreator(java.lang.String creator) Sets the creator value.
void	setKeywords(java.util.List keywords) Sets a list of keyword values to import into a PDF document.
void	setProducer(java.lang.String producer) Sets a producer value to import into a PDF document.
void	setSubject(java.lang.String subject) Sets a subject value.
void	setTitle(java.lang.String title) Sets a title value.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMPUtilityMetadata

public XMPUtilityMetadata()

A constructor that creates a XMPUtilityMetadata instance. When you create this object, all metadata values are null. You must set them by invoking the appropriate method. For example, to set the author value, invoke setAuthor.

Method Detail

getAuthor

public java.lang.String getAuthor()

Gets the author value.

Returns:

A string value that represents the author value.

See Also:

setAuthor

setAuthor

public void setAuthor(java.lang.String author)

Sets the author value.

Parameters:

author - A string value that represents the author value.

See Also:

getAuthor

getCreator

public java.lang.String getCreator()

Gets the creator value.

Returns:

A string value that represents the creator value.

See Also:

setCreator

setCreator

public void setCreator(java.lang.String creator)

Sets the creator value.

Parameters:

creator - A string value that represents the creator value.

See Also:

getCreator

getKeywords

public java.util.List getKeywords()

Gets a list of keyword values.

Returns:

A java.util.List object that contains keyword values.

See Also:

setKeywords

setKeywords

public void setKeywords(java.util.List keywords)

Sets a list of keyword values to import into a PDF document. Empty or null string values will not be added.

Parameters:

keywords - A java.util.List object that contains keyword values.

See Also:

getKeywords

getProducer

public java.lang.String getProducer()

Gets a producer value.

Returns:

A string value that represents the producer value.

See Also:

setProducer

setProducer

public void setProducer(java.lang.String producer)

Sets a producer value to import into a PDF document.

Parameters:

producer - A string value that represents the producer value.

See Also:

getProducer

getSubject

public java.lang.String getSubject()

Gets a subject value.

Returns:

A string value that represents the subject value.

See Also:

setSubject

setSubject

public void setSubject(java.lang.String subject)

Sets a subject value.

Parameters:

subject - A string value that represents the subject value.

See Also:

getSubject

getTitle

public java.lang.String getTitle()

Gets a title value.

Returns:

A string value that represents the title value.

See Also:

setTitle

setTitle

public void setTitle(java.lang.String title)

Sets a title value.

Parameters:

title - A string value that represents the title.

See Also:

setTitle