XMLGregorianCalendar JDK 1.6)

Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
XML Schema 1.0 datatype field	Related XMLGregorianCalendar Accessor(s)	Value Range
year	`XMLGregorianCalendar.getYear()` + `XMLGregorianCalendar.getEon()` or `XMLGregorianCalendar.getEonAndYear()`	`getYear()` is a value between -(10^9-1) to (10^9)-1 or `DatatypeConstants.FIELD_UNDEFINED`. `XMLGregorianCalendar.getEon()` is high order year value in billion of years. `getEon()` has values greater than or equal to (10^9) or less than or equal to -(10^9). A value of null indicates field is undefined. Given that XML Schema 1.0 errata states that the year zero will be a valid lexical value in a future version of XML Schema, this class allows the year field to be set to zero. Otherwise, the year field value is handled exactly as described in the errata and [ISO-8601-1988]. Note that W3C XML Schema 1.0 validation does not allow for the year field to have a value of zero.
month	`XMLGregorianCalendar.getMonth()`	1 to 12 or `DatatypeConstants.FIELD_UNDEFINED`
day	`XMLGregorianCalendar.getDay()`	Independent of month, max range is 1 to 31 or `DatatypeConstants.FIELD_UNDEFINED`. The normative value constraint stated relative to month field's value is in W3C XML Schema 1.0 Part 2, Appendix D.
hour	`XMLGregorianCalendar.getHour()`	0 to 24 or `DatatypeConstants.FIELD_UNDEFINED`. For a value of 24, the minute and second field must be zero per XML Schema Errata.
minute	`XMLGregorianCalendar.getMinute()`	0 to 59 or `DatatypeConstants.FIELD_UNDEFINED`
second	`XMLGregorianCalendar.getSecond()` + `XMLGregorianCalendar.getMillisecond()`/1000 or `XMLGregorianCalendar.getSecond()` + `XMLGregorianCalendar.getFractionalSecond()`	`XMLGregorianCalendar.getSecond()` from 0 to 60 or `DatatypeConstants.FIELD_UNDEFINED`. (Note: 60 only allowable for leap second.) `XMLGregorianCalendar.getFractionalSecond()` allows for infinite precision over the range from 0.0 to 1.0 when the `XMLGregorianCalendar.getSecond()` is defined. `FractionalSecond` is optional and has a value of `null` when it is undefined. `XMLGregorianCalendar.getMillisecond()` is the convenience millisecond precision of value of `XMLGregorianCalendar.getFractionalSecond()`.
timezone	`XMLGregorianCalendar.getTimezone()`	Number of minutes or `DatatypeConstants.FIELD_UNDEFINED`. Value range from -14 hours (-14 * 60 minutes) to 14 hours (14 * 60 minutes).

publicabstract 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.

Parameters:
- duration - Duration to add to this XMLGregorianCalendar.
Throws:
- NullPointerException - when duration parameter is null.

publicabstract void clear ()

Unset all fields to undefined.

publicabstract Object clone ()

Creates and returns a copy of this object.

Returns: copy of this Object

publicabstract 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.

Returns: The relationship between this XMLGregorianCalendar and the specified xmlGregorianCalendar as {@link DatatypeConstants#LESSER}, {@link DatatypeConstants#EQUAL}, {@link DatatypeConstants#GREATER} or {@link DatatypeConstants#INDETERMINATE}.
Parameters:
- xmlGregorianCalendar - Instance of XMLGregorianCalendar to compare
Throws:
- NullPointerException - if xmlGregorianCalendar is null.

public boolean equals (Object obj)

Compares this calendar to the specified object.

Compares this calendar to the specified object. The result is true if and only if the argument is not null and is an XMLGregorianCalendar object that represents the same instant in time as this object.

Returns: true when obj is an instance of XMLGregorianCalendar and {@link #compare(XMLGregorianCalendar obj)} returns {@link DatatypeConstants#EQUAL}, otherwise false.
Parameters:
- obj - to compare.

publicabstract int getDay ()

Return day in month or DatatypeConstants.FIELD_UNDEFINED.

publicabstract BigInteger getEon ()

Return high order component for XML Schema 1.0 dateTime datatype field for year.

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.

Returns: eon of this XMLGregorianCalendar. The value returned is an integer multiple of 10^9.
See Also: XMLGregorianCalendar.getYear(), XMLGregorianCalendar.getEonAndYear(),

publicabstract 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.

Returns: sum of eon and BigInteger.valueOf(year) when both fields are defined. When only year is defined, return it. When both eon and year are not defined, return null.
See Also: XMLGregorianCalendar.getEon(), XMLGregorianCalendar.getYear(),

publicabstract 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 XMLGregorianCalendar.getSecond(), does not return DatatypeConstants.FIELD_UNDEFINED.

Returns: fractional seconds of this XMLGregorianCalendar.
See Also: XMLGregorianCalendar.getSecond(), XMLGregorianCalendar.setTime(int, int, int, BigDecimal),

publicabstract int getHour ()

Return hours or DatatypeConstants.FIELD_UNDEFINED.

public int getMillisecond ()

Return millisecond precision of XMLGregorianCalendar.getFractionalSecond().

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

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

Returns: Millisecond of this XMLGregorianCalendar.
See Also: XMLGregorianCalendar.getFractionalSecond(), XMLGregorianCalendar.setTime(int, int, int),

publicabstract int getMinute ()

Return minutes or DatatypeConstants.FIELD_UNDEFINED.

publicabstract int getMonth ()

Return number of month or DatatypeConstants.FIELD_UNDEFINED.

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

Returns: year of this XMLGregorianCalendar.

publicabstract int getSecond ()

Return seconds or DatatypeConstants.FIELD_UNDEFINED.

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

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

Returns: Second of this XMLGregorianCalendar.
See Also: XMLGregorianCalendar.getFractionalSecond(), XMLGregorianCalendar.getMillisecond(), XMLGregorianCalendar.setTime(int, int, int),

publicabstract int getTimezone ()

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

publicabstract TimeZone getTimeZone (int defaultZoneoffset)

Returns a java.util.TimeZone for this class.

publicabstract QName getXMLSchemaType ()

Return the name of the XML Schema date/time type that this instance maps to.

Required fields for XML Schema 1.0 Date/Time Datatypes. (timezone is optional for all date/time datatypes)
Datatype	year	month	day	hour	minute	second
`DatatypeConstants.DATETIME`	X	X	X	X	X	X
`DatatypeConstants.DATE`	X	X	X
`DatatypeConstants.TIME`				X	X	X
`DatatypeConstants.GYEARMONTH`	X	X
`DatatypeConstants.GMONTHDAY`		X	X
`DatatypeConstants.GYEAR`	X
`DatatypeConstants.GMONTH`		X
`DatatypeConstants.GDAY`			X

publicabstract int getYear ()

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

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

Returns: year of this XMLGregorianCalendar.
See Also: XMLGregorianCalendar.getEon(), XMLGregorianCalendar.getEonAndYear(),

public int hashCode ()

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

publicabstract boolean isValid ()

Validate instance by getXMLSchemaType() constraints.

Validate instance by getXMLSchemaType() constraints.
Returns: true if data values are valid.

publicabstract 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).

Returns: this XMLGregorianCalendar normalized to UTC.

publicabstract void reset ()

Reset this XMLGregorianCalendar to its original values.

publicabstract void setDay (int day)

Set days in month.

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

Parameters:
- day - value constraints summarized in day field of date/time field mapping table.
Throws:
- IllegalArgumentException - if day parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setFractionalSecond (BigDecimal fractional)

Set fractional seconds.

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

Parameters:
- fractional - value constraints summarized in second field of date/time field mapping table.
Throws:
- IllegalArgumentException - if fractional parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setHour (int hour)

Set hours.

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

Parameters:
- hour - value constraints summarized in hour field of date/time field mapping table.
Throws:
- IllegalArgumentException - if hour parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setMillisecond (int millisecond)

Set milliseconds.

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

Parameters:
- millisecond - value constraints summarized in second field of date/time field mapping table.
Throws:
- IllegalArgumentException - if millisecond parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setMinute (int minute)

Set minutes.

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

Parameters:
- minute - value constraints summarized in minute field of date/time field mapping table.
Throws:
- IllegalArgumentException - if minute parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setMonth (int month)

Set month.

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

Parameters:
- month - value constraints summarized in month field of date/time field mapping table.
Throws:
- IllegalArgumentException - if month parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setSecond (int second)

Set seconds.

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

Parameters:
- second - value constraints summarized in second field of date/time field mapping table.
Throws:
- IllegalArgumentException - if second parameter is outside value constraints for the field as specified in date/time field mapping table.

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

Set time as one unit.

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

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

Parameters:
- hour - value constraints are summarized in hour field of date/time field mapping table.
- minute - value constraints are summarized in minute field of date/time field mapping table.
- second - value constraints are summarized in second field of date/time field mapping table.
- fractional - value of null indicates this optional field is not set.
Throws:
- IllegalArgumentException - if any parameter is outside value constraints for the field as specified in date/time field mapping table.

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

Set time as one unit, including optional milliseconds.

publicabstract 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 DatatypeConstants.FIELD_UNDEFINED.

Parameters:
- offset - value constraints summarized in timezone field of date/time field mapping table.
Throws:
- IllegalArgumentException - if offset parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract 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.

Parameters:
- year - value constraints summarized in year field of date/time field mapping table.
Throws:
- IllegalArgumentException - if year parameter is outside value constraints for the field as specified in date/time field mapping table.

publicabstract void setYear (int year)

Set year of XSD dateTime year field.

Unset this field by invoking the setter with a parameter value of DatatypeConstants.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.

Parameters:
- year - value constraints are summarized in year field of date/time field mapping table. If year is {@link DatatypeConstants#FIELD_UNDEFINED}, then eon is set to null.

publicabstract GregorianCalendar toGregorianCalendar ()

Convert this XMLGregorianCalendar to a GregorianCalendar.

Field by Field Conversion from this class to `java.util.GregorianCalendar`
`java.util.GregorianCalendar` field	`javax.xml.datatype.XMLGregorianCalendar` field
`ERA`	`XMLGregorianCalendar.getEonAndYear().signum() < 0 ? GregorianCalendar.BC : GregorianCalendar.AD`
`YEAR`	`XMLGregorianCalendar.getEonAndYear().abs().intValue()`*
`MONTH`	`XMLGregorianCalendar.getMonth()` - `DatatypeConstants.JANUARY` + `Calendar.JANUARY`
`DAY_OF_MONTH`	`XMLGregorianCalendar.getDay()`
`HOUR_OF_DAY`	`XMLGregorianCalendar.getHour()`
`MINUTE`	`XMLGregorianCalendar.getMinute()`
`SECOND`	`XMLGregorianCalendar.getSecond()`
`MILLISECOND`	get millisecond order from `XMLGregorianCalendar.getFractionalSecond()`*
`GregorianCalendar.setTimeZone(TimeZone)`	`XMLGregorianCalendar.getTimezone()` formatted into Custom timezone id

publicabstract 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 Calendar.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)

Returns:

Parameters:

timezone

null

aLocale

null

defaults

defaults

null

defaults

java.util.GregorianCalendar

public String toString ()

Returns a String representation of this XMLGregorianCalendar Object.

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

Returns: A non-null valid String representation of this XMLGregorianCalendar.
Throws:
- IllegalStateException - if the combination of set fields does not match one of the eight defined XML Schema builtin date/time datatypes.
See Also: XMLGregorianCalendar.toXMLFormat(),

publicabstract String toXMLFormat ()

Return the lexical representation of this instance.

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 XMLGregorianCalendar.getXMLSchemaType().

Returns: XML, as String, representation of this XMLGregorianCalendar
Throws:
- IllegalStateException - if the combination of set fields does not match one of the eight defined XML Schema builtin date/time datatypes.