XMLGregorianCalendar

XMLGregorianCalendar

XMLGregorianCalendar ()

add

void add (Duration duration)

Add duration to this instance.

The computation is specified in XML Schema 1.0 Part 2, Appendix E, Adding durations to dateTimes>. date/time field mapping table defines the mapping from XML Schema 1.0 dateTime fields to this class' representation of those fields.

clear

void clear ()

Unset all fields to undefined.

Set all int fields to FIELD_UNDEFINED and reference fields to null.

clone

Object clone ()

Creates and returns a copy of this object.

compare

int compare (XMLGregorianCalendar xmlGregorianCalendar)

Compare two instances of W3C XML Schema 1.0 date/time datatypes according to partial order relation defined in W3C XML Schema 1.0 Part 2, Section 3.2.7.3, Order relation on dateTime.

xsd:dateTime datatype field mapping to accessors of this class are defined in date/time field mapping table.

equals

boolean equals (Object obj)

Indicates whether parameter obj is "equal to" this one.

getDay

int getDay ()

Return day in month or FIELD_UNDEFINED.

Value constraints for this value are summarized in day field of date/time field mapping table.

getEon

BigInteger getEon ()

Return high order component for XML Schema 1.0 dateTime datatype field for year. null if this optional part of the year field is not defined.

Value constraints for this value are summarized in year field of date/time field mapping table.

getEonAndYear

BigInteger getEonAndYear ()

Return XML Schema 1.0 dateTime datatype field for year.

Value constraints for this value are summarized in year field of date/time field mapping table.

getFractionalSecond

BigDecimal getFractionalSecond ()

Return fractional seconds.

null is returned when this optional field is not defined.

Value constraints are detailed in second field of date/time field mapping table.

This optional field can only have a defined value when the xs:dateTime second field, represented by getSecond(), does not return FIELD_UNDEFINED.

getHour

int getHour ()

Return hours or FIELD_UNDEFINED. Returns FIELD_UNDEFINED if this field is not defined.

Value constraints for this value are summarized in hour field of date/time field mapping table.

getMillisecond

int getMillisecond ()

Return millisecond precision of getFractionalSecond().

This method represents a convenience accessor to infinite precision fractional second value returned by getFractionalSecond(). The returned value is the rounded down to milliseconds value of getFractionalSecond(). When getFractionalSecond() returns null, this method must return FIELD_UNDEFINED.

Value constraints for this value are summarized in second field of date/time field mapping table.

getMinute

int getMinute ()

Return minutes or FIELD_UNDEFINED.

Value constraints for this value are summarized in minute field of date/time field mapping table.

getMonth

int getMonth ()

Return number of month or FIELD_UNDEFINED.

Value constraints for this value are summarized in month field of date/time field mapping table.

getSecond

int getSecond ()

Return seconds or FIELD_UNDEFINED.

Returns FIELD_UNDEFINED if this field is not defined. When this field is not defined, the optional xs:dateTime fractional seconds field, represented by getFractionalSecond() and getMillisecond(), must not be defined.

Value constraints for this value are summarized in second field of date/time field mapping table.

getTimeZone

TimeZone getTimeZone (int defaultZoneoffset)

Returns a java.util.TimeZone for this class.

If timezone field is defined for this instance, returns TimeZone initialized with custom timezone id of zoneoffset. If timezone field is undefined, try the defaultZoneoffset that was passed in. If defaultZoneoffset is FIELD_UNDEFINED, return default timezone for this host. (Same default as java.util.GregorianCalendar).

getTimezone

int getTimezone ()

Return timezone offset in minutes or FIELD_UNDEFINED if this optional field is not defined.

Value constraints for this value are summarized in timezone field of date/time field mapping table.

getXMLSchemaType

QName getXMLSchemaType ()

Return the name of the XML Schema date/time type that this instance maps to. Type is computed based on fields that are set.

getYear

int getYear ()

Return low order component for XML Schema 1.0 dateTime datatype field for year or FIELD_UNDEFINED.

Value constraints for this value are summarized in year field of date/time field mapping table.

hashCode

int hashCode ()

Returns a hash code consistent with the definition of the equals method.

isValid

boolean isValid ()

Validate instance by getXMLSchemaType() constraints.

normalize

XMLGregorianCalendar normalize ()

Normalize this instance to UTC.

2000-03-04T23:00:00+03:00 normalizes to 2000-03-04T20:00:00Z

Implements W3C XML Schema Part 2, Section 3.2.7.3 (A).

reset

void reset ()

Reset this XMLGregorianCalendar to its original values.

XMLGregorianCalendar is reset to the same values as when it was created with newXMLGregorianCalendar(), newXMLGregorianCalendar(String), newXMLGregorianCalendar(BigInteger, int, int, int, int, int, BigDecimal, int), newXMLGregorianCalendar(int, int, int, int, int, int, int, int), newXMLGregorianCalendar(GregorianCalendar), newXMLGregorianCalendarDate(int, int, int, int), newXMLGregorianCalendarTime(int, int, int, int), newXMLGregorianCalendarTime(int, int, int, BigDecimal, int) or newXMLGregorianCalendarTime(int, int, int, int, int).

reset() is designed to allow the reuse of existing XMLGregorianCalendars thus saving resources associated with the creation of new XMLGregorianCalendars.

setDay

void setDay (int day)

Set days in month.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setFractionalSecond

void setFractionalSecond (BigDecimal fractional)

Set fractional seconds.

Unset this field by invoking the setter with a parameter value of null.

setHour

void setHour (int hour)

Set hours.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setMillisecond

void setMillisecond (int millisecond)

Set milliseconds.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setMinute

void setMinute (int minute)

Set minutes.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setMonth

void setMonth (int month)

Set month.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setSecond

void setSecond (int second)

Set seconds.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setTime

void setTime (int hour, 
                int minute, 
                int second, 
                BigDecimal fractional)

Set time as one unit, including the optional infinite precision fractional seconds.

setTime

void setTime (int hour, 
                int minute, 
                int second)

Set time as one unit.

setTime

void setTime (int hour, 
                int minute, 
                int second, 
                int millisecond)

Set time as one unit, including optional milliseconds.

setTimezone

void setTimezone (int offset)

Set the number of minutes in the timezone offset.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

setYear

void setYear (BigInteger year)

Set low and high order component of XSD dateTime year field.

Unset this field by invoking the setter with a parameter value of null.

setYear

void setYear (int year)

Set year of XSD dateTime year field.

Unset this field by invoking the setter with a parameter value of FIELD_UNDEFINED.

Note: if the absolute value of the year parameter is less than 10^9, the eon component of the XSD year field is set to null by this method.

toGregorianCalendar

GregorianCalendar toGregorianCalendar ()

Convert this XMLGregorianCalendar to a GregorianCalendar.

When this instance has an undefined field, this conversion relies on the java.util.GregorianCalendar default for its corresponding field. A notable difference between XML Schema 1.0 date/time datatypes and java.util.GregorianCalendar is that Timezone value is optional for date/time datatypes and it is a required field for java.util.GregorianCalendar. See javadoc for java.util.TimeZone.getDefault() on how the default is determined. To explicitly specify the TimeZone instance, see toGregorianCalendar(TimeZone, Locale, XMLGregorianCalendar).

To ensure consistency in conversion implementations, the new GregorianCalendar should be instantiated in following manner.

• Using timeZone value as defined above, create a new java.util.GregorianCalendar(timeZone,Locale.getDefault()).
• Initialize all GregorianCalendar fields by calling {(@link GegorianCalendar#clear()}.
• Obtain a pure Gregorian Calendar by invoking GregorianCalendar.setGregorianChange( new Date(Long.MIN_VALUE)).
• Its fields ERA, YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND and MILLISECOND are set using the method Calendar.set(int,int)

toGregorianCalendar

GregorianCalendar toGregorianCalendar (TimeZone timezone, 
                Locale aLocale, 
                XMLGregorianCalendar defaults)

Convert this XMLGregorianCalendar along with provided parameters to a GregorianCalendar instance.

Since XML Schema 1.0 date/time datetypes has no concept of timezone ids or daylight savings timezone ids, this conversion operation allows the user to explicitly specify one with timezone parameter.

To compute the return value's TimeZone field,

• when parameter timeZone is non-null, it is the timezone field.
• else when this.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using the this.getTimezone().
• else when defaults.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using defaults.getTimezone().
• else use the GregorianCalendar default timezone value for the host is defined as specified by java.util.TimeZone.getDefault().

To ensure consistency in conversion implementations, the new GregorianCalendar should be instantiated in following manner.

• Create a new java.util.GregorianCalendar(TimeZone, Locale) with TimeZone set as specified above and the Locale parameter.
• Initialize all GregorianCalendar fields by calling clear()
• Obtain a pure Gregorian Calendar by invoking GregorianCalendar.setGregorianChange( new Date(Long.MIN_VALUE)).
• Its fields ERA, YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND and MILLISECOND are set using the method Calendar.set(int,int)

toString

String toString ()

Returns a String representation of this XMLGregorianCalendar Object.

The result is a lexical representation generated by toXMLFormat().

toXMLFormat

String toXMLFormat ()

Return the lexical representation of this instance. The format is specified in XML Schema 1.0 Part 2, Section 3.2.[7-14].1, Lexical Representation".

Specific target lexical representation format is determined by getXMLSchemaType().