pdftron.PDF

Class Date

java.lang.Object

pdftron.PDF.Date

public class Date
extends java.lang.Object

The Date class is a utility class used to simplify work with PDF date objects. PDF defines a standard date format, which closely follows international standard ASN.1 (Abstract Syntax Notation One), A date is a string of the form (D:YYYYMMDDHHmmSSOHH'mm'); See PDF Reference Manual for details. Date can be associated with a SDF/Cos date string using Date(Obj*) constructor or later using Date::Attach(Obj*) or Date::Update(Obj*) methods. Date keeps a local date/time cache so it is necessary to call Date::Update() method if the changes to the Date should be saved in the attached Cos/SDF string.

Constructor Summary

Constructors

Constructor and Description
Date() Date default constructor.
Date(Obj d) Create a Date and initialize it using given Cos/SDF string date object.
Date(short year, byte month, byte day, byte hour, byte minute, byte second) Create a Date and initialize it using specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
static Date	__Create(long impl)
long	__GetHandle()
void	attach(Obj d) Attach the Cos/SDF object to the Date.
boolean	equals(java.lang.Object other)
byte	getDay() Get the day.
byte	getHour() Get the hour.
byte	getMinute() Get the minute.
byte	getMonth() Get the month.
byte	getSecond() Get the second.
byte	getUT() Get the relationship of local time to Universal Time (UT), denoted by one of the characters +, -, or Z
byte	getUTHour() Get the absolute value of the offset from UT in hours (00-23)
byte	getUTMinutes() Get the absolute value of the offset from UT in minutes (00-59)
short	getYear() Get the year.
int	hashCode()
boolean	isValid() Indicates whether the Date is valid (non-null).
void	setCurrentTime() Set the current time.
void	setDay(byte day) Set the day.
void	setHour(byte hour) Set the hour.
void	setMinute(byte minute) Set the minute.
void	setMonth(byte month) Set the month.
void	setSecond(byte second) Set the second.
void	setUT(byte ut) Set the relationship of local time to Universal Time (UT),
void	setUTHour(byte ut_hour) Set the absolute value of the offset from UT in hours (00-23)
void	setYear(short year) Set the year.
void	seUTMinutes(byte ut_minutes) Set the absolute value of the offset from UT in minutes (00-59)
boolean	update() Saves changes made to the Date object in the attached (or specified) SDF/Cos string.
boolean	update(Obj d) Saves changes made to the Date object in the attached (or specified) SDF/Cos string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Date

public Date()
     throws PDFNetException

Date default constructor.

Throws:

PDFNetException

Date

public Date(Obj d)
     throws PDFNetException

Create a Date and initialize it using given Cos/SDF string date object. String date object is attached to this Date.

Parameters:

d - input string date object

Throws:

PDFNetException

Date

public Date(short year,
    byte month,
    byte day,
    byte hour,
    byte minute,
    byte second)
     throws PDFNetException

Create a Date and initialize it using specified parameters. The Date is not attached to any Cos/SDF object.

Parameters:

year -

month -

day -

hour -

minute -

second -

Throws:

PDFNetException

Method Detail

isValid

public boolean isValid()
                throws PDFNetException

Indicates whether the Date is valid (non-null).

Returns:

True if this is a valid (non-null) Date; otherwise false.

Throws:

PDFNetException

Note:

If this method returns false the underlying SDF/Cos object is null and the Date object should be treated as null as well.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

attach

public void attach(Obj d)
            throws PDFNetException

Attach the Cos/SDF object to the Date.

Parameters:

d - - underlying Cos/SDF object. Must be an SDF::Str containing a PDF date object.

Throws:

PDFNetException

update

public boolean update()
               throws PDFNetException

Saves changes made to the Date object in the attached (or specified) SDF/Cos string.

Returns:

true if the attached Cos/SDF string was successfully updated, false otherwise.

Throws:

PDFNetException

update

public boolean update(Obj d)
               throws PDFNetException

Saves changes made to the Date object in the attached (or specified) SDF/Cos string.

Parameters:

d - - an optional parameter indicating a SDF string that should be updated and attached to this Date. If parameter d is NULL or is omitted, update is performed on previously attached Cos/SDF date.

Returns:

true, if successful

Throws:

PDFNetException

setCurrentTime

public void setCurrentTime()

Set the current time.

getYear

public short getYear()
              throws PDFNetException

Get the year.

Returns:

the year

Throws:

PDFNetException

getMonth

public byte getMonth()
              throws PDFNetException

Get the month.

Returns:

the month

Throws:

PDFNetException

getDay

public byte getDay()
            throws PDFNetException

Get the day.

Returns:

the day (01-31).

Throws:

PDFNetException

getHour

public byte getHour()
             throws PDFNetException

Get the hour.

Returns:

the hour (00-23).

Throws:

PDFNetException

getMinute

public byte getMinute()
               throws PDFNetException

Get the minute.

Returns:

the minute (00-59).

Throws:

PDFNetException

getSecond

public byte getSecond()
               throws PDFNetException

Get the second.

Returns:

the second (00-59).

Throws:

PDFNetException

getUT

public byte getUT()
           throws PDFNetException

Get the relationship of local time to Universal Time (UT), denoted by one of the characters +, -, or Z

Returns:

The relationship of local time to Universal Time (UT), denoted by one of the characters +, -, or Z

Throws:

PDFNetException

getUTHour

public byte getUTHour()
               throws PDFNetException

Get the absolute value of the offset from UT in hours (00-23)

Returns:

the absolute value of the offset from UT in hours (00-23)

Throws:

PDFNetException

getUTMinutes

public byte getUTMinutes()
                  throws PDFNetException

Get the absolute value of the offset from UT in minutes (00-59)

Returns:

the absolute value of the offset from UT in minutes (00-59)

Throws:

PDFNetException

setYear

public void setYear(short year)
             throws PDFNetException

Set the year.

Parameters:

year - the new year

Throws:

PDFNetException

setMonth

public void setMonth(byte month)
              throws PDFNetException

Set the month.

Parameters:

month - the new month

Throws:

PDFNetException

setDay

public void setDay(byte day)
            throws PDFNetException

Set the day.

Parameters:

day - the new day

Throws:

PDFNetException

setHour

public void setHour(byte hour)
             throws PDFNetException

Set the hour.

Parameters:

hour - the new hour

Throws:

PDFNetException

setMinute

public void setMinute(byte minute)
               throws PDFNetException

Set the minute.

Parameters:

minute - the new minute

Throws:

PDFNetException

setSecond

public void setSecond(byte second)
               throws PDFNetException

Set the second.

Parameters:

second - the new second

Throws:

PDFNetException

setUT

public void setUT(byte ut)
           throws PDFNetException

Set the relationship of local time to Universal Time (UT),

Parameters:

ut - the relationship of local time to Universal Time (UT),

Throws:

PDFNetException

setUTHour

public void setUTHour(byte ut_hour)
               throws PDFNetException

Set the absolute value of the offset from UT in hours (00-23)

Parameters:

ut_hour - the absolute value of the offset from UT in hours (00-23)

Throws:

PDFNetException

seUTMinutes

public void seUTMinutes(byte ut_minutes)
                 throws PDFNetException

Set the absolute value of the offset from UT in minutes (00-59)

Parameters:

ut_minutes - the absolute value of the offset from UT in minutes (00-59)

Throws:

PDFNetException

__Create

public static Date __Create(long impl)

__GetHandle

public long __GetHandle()