com.itextpdf.forms.xfdf

Class IdsObject

java.lang.Object

com.itextpdf.forms.xfdf.IdsObject

public class IdsObject
extends Object

Represents ids element, child of the xfdf element. Corresponds to the ID key in the file dictionary. The two attributes are file identifiers for the source or target file designated by the f element, taken from the ID entry in the file’s trailer dictionary. Attributes: original, modified. For more details see paragraph 6.2.3 in Xfdf document specification.

Constructor Summary

Constructors

Constructor and Description
IdsObject() Creates an instance of IdsObject.

Method Summary

Modifier and Type	Method and Description
String	getModified() Gets the string value of the unique identifier for the modified version of the pdf and corresponding xfdf document.
String	getOriginal() Gets the string value of the permanent identifier which is based on the contents of the file at the time it was originally created.
IdsObject	setModified(String modified) Sets the string value of the unique identifier for the modified version of the pdf and corresponding xfdf document.
IdsObject	setOriginal(String original) Sets the string value of the permanent identifier which is based on the contents of the file at the time it was originally created.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdsObject

public IdsObject()

Creates an instance of IdsObject.

Method Detail

getOriginal

public String getOriginal()

Gets the string value of the permanent identifier which is based on the contents of the file at the time it was originally created. This value does not change when the file is incrementally updated. The value shall be a hexadecimal number.

Returns:

the permanent identifier value.

setOriginal

public IdsObject setOriginal(String original)

Sets the string value of the permanent identifier which is based on the contents of the file at the time it was originally created. This value does not change when the file is incrementally updated. The value shall be a hexadecimal number. A common value for this is an MD5 checksum.

Parameters:

original - the permanent identifier value

Returns:

current ids object.

getModified

public String getModified()

Gets the string value of the unique identifier for the modified version of the pdf and corresponding xfdf document. The modified attribute corresponds to the changing identifier that is based on the file's contents at the time it was last updated. The value shall be a hexadecimal number.

Returns:

the unique identifier value.

setModified

public IdsObject setModified(String modified)

Sets the string value of the unique identifier for the modified version of the pdf and corresponding xfdf document. The modified attribute corresponds to the changing identifier that is based on the file's contents at the time it was last updated. The value shall be a hexadecimal number. A common value for this is an MD5 checksum.

Parameters:

modified - the unique identifier value

Returns:

current ids object.