com.itextpdf.kernel.pdf

Class PdfDate

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfString>

com.itextpdf.kernel.pdf.PdfDate

public class PdfDate
extends PdfObjectWrapper<PdfString>

PdfDate is the PDF date object.

PDF defines a standard date format. The PDF date format closely follows the format defined by the international standard ASN.1 (Abstract Syntax Notation One, defined in CCITT X.208 or ISO/IEC 8824). A date is a PdfString of the form:

(D:YYYYMMDDHHmmSSOHH'mm')

See also ISO-320001 7.9.4, "Dates".

See Also:

PdfString, GregorianCalendar

Constructor Summary

Constructors

Constructor and Description
PdfDate() Constructs a PdfDate-object, representing the current day and time.
PdfDate(Calendar d) Constructs a PdfDate-object.

Method Summary

Modifier and Type	Method and Description
static Calendar	decode(String s) Converts a PDF string representing a date into a Calendar.
String	getW3CDate() Gives the W3C format of the PdfDate.
static String	getW3CDate(String d) Gives the W3C format of the PdfDate.
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfDate

public PdfDate(Calendar d)

Constructs a PdfDate-object.

Parameters:

d - the date that has to be turned into a PdfDate >-object

PdfDate

public PdfDate()

Constructs a PdfDate-object, representing the current day and time.

Method Detail

getW3CDate

public String getW3CDate()

Gives the W3C format of the PdfDate.

Returns:

a formatted date

getW3CDate

public static String getW3CDate(String d)

Gives the W3C format of the PdfDate.

Parameters:

d - the date in the format D:YYYYMMDDHHmmSSOHH'mm'

Returns:

a formatted date

decode

public static Calendar decode(String s)

Converts a PDF string representing a date into a Calendar.

Parameters:

s - the PDF string representing a date

Returns:

a Calendar representing the date or null if the string was not a date

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfString>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.