org.cip4.lib.xjdf.type

Class DateTime

java.lang.Object

javax.xml.bind.annotation.adapters.XmlAdapter<ValueType,BoundType>

org.cip4.lib.xjdf.type.AbstractXJdfType<java.lang.String,DateTime>

org.cip4.lib.xjdf.type.DateTime

public class DateTime
extends AbstractXJdfType<java.lang.String,DateTime>

Implementation of the XJDF DateTime data type.

Constructor Summary

Constructors

Constructor and Description
DateTime() Default constructor.
DateTime(java.util.Date date) Creates a XJDF DateTime instance by a Date object.
DateTime(int year, int month, int day) Custom constructor.
DateTime(int year, int month, int day, int hour, int minute) Custom constructor.
DateTime(int year, int month, int day, int hour, int minute, int second) Custom constructor.
DateTime(java.lang.String dateTime) Creates a XJDF DateTime instance by a String expression object.

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	getCalendar() Clones the underlying calendar and returns it.
java.lang.String	marshal(DateTime dateTime)
java.lang.String	toString()
java.lang.String	toString(java.util.TimeZone timeZone) Formats this DateTime object using the passed time zone.
DateTime	unmarshal(java.lang.String dateTime)

Methods inherited from class org.cip4.lib.xjdf.type.AbstractXJdfType

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTime

public DateTime()

Default constructor.

DateTime

public DateTime(int year,
                int month,
                int day)

Custom constructor. Accepting values for initializing.

Parameters:

year - The value used to set the YEAR.

month - The value used to set the MONTH in year. January is "0".

day - The value used to set the DAY in month.

DateTime

public DateTime(int year,
                int month,
                int day,
                int hour,
                int minute)

Custom constructor. Accepting values for initializing.

Parameters:

year - The value used to set the YEAR.

month - The value used to set the MONTH in year. January is "0".

day - The value used to set the DAY in month.

hour - The value used to set the HOUR of day.

minute - The value used to set the MINUTE in of.

DateTime

public DateTime(int year,
                int month,
                int day,
                int hour,
                int minute,
                int second)

Custom constructor. Accepting values for initializing.

Parameters:

year - The value used to set the YEAR.

month - The value used to set the MONTH in year. January is "0".

day - The value used to set the DAY in month.

hour - The value used to set the HOUR of day.

minute - The value used to set the MINUTE.

second - The value used to set the SECOND.

DateTime

public DateTime(java.lang.String dateTime)
         throws java.text.ParseException

Creates a XJDF DateTime instance by a String expression object.

Parameters:

dateTime - XJDF DateTime String expression. Should match the format yyyy-MM-dd'T'HH:mm:ss'Z'.

Throws:

java.text.ParseException - if the passed expression

DateTime

public DateTime(java.util.Date date)

Creates a XJDF DateTime instance by a Date object.

Parameters:

date - Date object.

Method Detail

getCalendar

public final java.util.Calendar getCalendar()

Clones the underlying calendar and returns it.

Returns:

the cloned calendar

marshal

public final java.lang.String marshal(DateTime dateTime)

Specified by:

marshal in class javax.xml.bind.annotation.adapters.XmlAdapter<java.lang.String,DateTime>

See Also:

XmlAdapter.marshal(java.lang.Object)

unmarshal

public final DateTime unmarshal(java.lang.String dateTime)
                         throws java.lang.Exception

Specified by:

unmarshal in class javax.xml.bind.annotation.adapters.XmlAdapter<java.lang.String,DateTime>

Throws:

java.lang.Exception

See Also:

XmlAdapter.unmarshal(java.lang.Object)

toString

public final java.lang.String toString()

Specified by:

toString in class AbstractXJdfType<java.lang.String,DateTime>

See Also:

Object.toString()

toString

public final java.lang.String toString(java.util.TimeZone timeZone)

Formats this DateTime object using the passed time zone.

Parameters:

timeZone - The time zone to use.

Returns:

String representation based for the passed time zone.