Android APIs
public abstract class

XMLGregorianCalendar

extends Object
implements Cloneable
java.lang.Object
   ↳ javax.xml.datatype.XMLGregorianCalendar

Class Overview

Representation for W3C XML Schema 1.0 date/time datatypes. Specifically, these date/time datatypes are dateTime, time, date, gYearMonth, gMonthDay, gYear gMonth and gDay defined in the XML Namespace "http://www.w3.org/2001/XMLSchema". These datatypes are normatively defined in W3C XML Schema 1.0 Part 2, Section 3.2.7-14.

The table below defines the mapping between XML Schema 1.0 date/time datatype fields and this class' fields. It also summarizes the value constraints for the date and time fields defined in W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats.

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 getYear() + getEon() or
getEonAndYear()
getYear() is a value between -(10^9-1) to (10^9)-1 or FIELD_UNDEFINED.
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 getMonth() 1 to 12 or FIELD_UNDEFINED
day getDay() Independent of month, max range is 1 to 31 or 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 getHour() 0 to 24 or FIELD_UNDEFINED. For a value of 24, the minute and second field must be zero per XML Schema Errata.
minute getMinute() 0 to 59 or FIELD_UNDEFINED
second getSecond() + getMillisecond()/1000 or
getSecond() + getFractionalSecond()
getSecond() from 0 to 60 or FIELD_UNDEFINED.
(Note: 60 only allowable for leap second.)
getFractionalSecond() allows for infinite precision over the range from 0.0 to 1.0 when the getSecond() is defined.
FractionalSecond is optional and has a value of null when it is undefined.
getMillisecond() is the convenience millisecond precision of value of getFractionalSecond().
timezone getTimezone() Number of minutes or FIELD_UNDEFINED. Value range from -14 hours (-14 * 60 minutes) to 14 hours (14 * 60 minutes).

All maximum value space constraints listed for the fields in the table above are checked by factory methods, @{link DatatypeFactory}, setter methods and parse methods of this class. IllegalArgumentException is thrown when a parameter's value is outside the value constraint for the field or if the composite values constitute an invalid XMLGregorianCalendar instance (for example, if the 31st of June is specified).

The following operations are defined for this class:

Summary

Public Constructors
XMLGregorianCalendar()
Public Methods
abstract void add(Duration duration)

Add duration to this instance.

abstract void clear()

Unset all fields to undefined.

abstract Object clone()

Creates and returns a copy of this object.

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

boolean equals(Object obj)

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

abstract int getDay()
Return day in month or FIELD_UNDEFINED.
abstract BigInteger getEon()

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

abstract BigInteger getEonAndYear()

Return XML Schema 1.0 dateTime datatype field for year.

abstract BigDecimal getFractionalSecond()

Return fractional seconds.

abstract int getHour()
Return hours or FIELD_UNDEFINED.
int getMillisecond()

Return millisecond precision of getFractionalSecond().

abstract int getMinute()
Return minutes or FIELD_UNDEFINED.
abstract int getMonth()

Return number of month or FIELD_UNDEFINED.

abstract int getSecond()

Return seconds or FIELD_UNDEFINED.

abstract TimeZone getTimeZone(int defaultZoneoffset)

Returns a java.util.TimeZone for this class.

abstract int getTimezone()
Return timezone offset in minutes or FIELD_UNDEFINED if this optional field is not defined.
abstract QName getXMLSchemaType()

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

abstract int getYear()

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

int hashCode()

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

abstract boolean isValid()
Validate instance by getXMLSchemaType() constraints.
abstract XMLGregorianCalendar normalize()

Normalize this instance to UTC.

abstract void reset()

Reset this XMLGregorianCalendar to its original values.

abstract void setDay(int day)

Set days in month.

abstract void setFractionalSecond(BigDecimal fractional)

Set fractional seconds.

abstract void setHour(int hour)

Set hours.

abstract void setMillisecond(int millisecond)

Set milliseconds.

abstract void setMinute(int minute)

Set minutes.

abstract void setMonth(int month)

Set month.

abstract void setSecond(int second)

Set seconds.

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

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

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

Set time as one unit, including optional milliseconds.

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

Set time as one unit.

abstract void setTimezone(int offset)

Set the number of minutes in the timezone offset.

abstract void setYear(int year)

Set year of XSD dateTime year field.

abstract void setYear(BigInteger year)

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

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

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

abstract GregorianCalendar toGregorianCalendar()

Convert this XMLGregorianCalendar to a GregorianCalendar.

String toString()

Returns a String representation of this XMLGregorianCalendar Object.

abstract String toXMLFormat()

Return the lexical representation of this instance.

[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public XMLGregorianCalendar ()

Added in API level 8

Public Methods

public abstract void add (Duration duration)

Added in API level 8

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.

public abstract void clear ()

Added in API level 8

Unset all fields to undefined.

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

public abstract Object clone ()

Added in API level 8

Creates and returns a copy of this object.

Returns
Object copy of this Object

public abstract int compare (XMLGregorianCalendar xmlGregorianCalendar)

Added in API level 8

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.

Parameters
xmlGregorianCalendar Instance of XMLGregorianCalendar to compare
Returns
int The relationship between this XMLGregorianCalendar and the specified xmlGregorianCalendar as LESSER, EQUAL, GREATER or INDETERMINATE.
Throws
NullPointerException if xmlGregorianCalendar is null.

public boolean equals (Object obj)

Added in API level 8

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

Parameters
obj to compare.
Returns
boolean true when obj is an instance of XMLGregorianCalendar and compare(XMLGregorianCalendar) returns EQUAL, otherwise false.

public abstract int getDay ()

Added in API level 8

Return day in month or FIELD_UNDEFINED.

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

Returns
int

See also:

public abstract BigInteger getEon ()

Added in API level 8

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
BigInteger eon of this XMLGregorianCalendar. The value returned is an integer multiple of 10^9.

public abstract BigInteger getEonAndYear ()

Added in API level 8

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
BigInteger 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:

public abstract BigDecimal getFractionalSecond ()

Added in API level 8

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.

Returns
BigDecimal fractional seconds of this XMLGregorianCalendar.

public abstract int getHour ()

Added in API level 8

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.

Returns
int

public int getMillisecond ()

Added in API level 8

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.

Returns
int Millisecond of this XMLGregorianCalendar.

public abstract int getMinute ()

Added in API level 8

Return minutes or FIELD_UNDEFINED.

Returns FIELD_UNDEFINED if this field is not defined.

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

Returns
int

public abstract int getMonth ()

Added in API level 8

Return number of month or FIELD_UNDEFINED.

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

Returns
int year of this XMLGregorianCalendar.

public abstract int getSecond ()

Added in API level 8

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.

Returns
int Second of this XMLGregorianCalendar.

public abstract TimeZone getTimeZone (int defaultZoneoffset)

Added in API level 8

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

Parameters
defaultZoneoffset default zoneoffset if this zoneoffset is FIELD_UNDEFINED.
Returns
TimeZone TimeZone for this.

public abstract int getTimezone ()

Added in API level 8

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.

Returns
int

See also:

public abstract QName getXMLSchemaType ()

Added in API level 8

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

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
DATETIME X X X X X X
DATE X X X
TIME X X X
GYEARMONTH X X
GMONTHDAY X X
GYEAR X
GMONTH X
GDAY X

Returns
QName One of the following class constants: DATETIME, TIME, DATE, GYEARMONTH, GMONTHDAY, GYEAR, GMONTH or GDAY.
Throws
IllegalStateException if the combination of set fields does not match one of the eight defined XML Schema builtin date/time datatypes.

public abstract int getYear ()

Added in API level 8

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.

Returns
int year of this XMLGregorianCalendar.

public int hashCode ()

Added in API level 8

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

Returns
int hash code of this object.

public abstract boolean isValid ()

Added in API level 8

Validate instance by getXMLSchemaType() constraints.

Returns
boolean true if data values are valid.

public abstract XMLGregorianCalendar normalize ()

Added in API level 8

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
XMLGregorianCalendar this XMLGregorianCalendar normalized to UTC.

public abstract void reset ()

Added in API level 8

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.

public abstract void setDay (int day)

Added in API level 8

Set days in month.

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

public abstract void setFractionalSecond (BigDecimal fractional)

Added in API level 8

Set fractional seconds.

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

Parameters
fractional value constraints summarized in fractional 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.

public abstract void setHour (int hour)

Added in API level 8

Set hours.

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

public abstract void setMillisecond (int millisecond)

Added in API level 8

Set milliseconds.

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

Parameters
millisecond value constraints summarized in millisecond 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.

public abstract void setMinute (int minute)

Added in API level 8

Set minutes.

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

public abstract void setMonth (int month)

Added in API level 8

Set month.

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

public abstract void setSecond (int second)

Added in API level 8

Set seconds.

Unset this field by invoking the setter with a parameter value of 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, BigDecimal fractional)

Added in API level 8

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)

Added in API level 8

Set time as one unit, including optional milliseconds.

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.
millisecond value of FIELD_UNDEFINED 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)

Added in API level 8

Set time as one unit.

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.
Throws
IllegalArgumentException if any parameter is outside value constraints for the field as specified in date/time field mapping table.

public abstract void setTimezone (int offset)

Added in API level 8

Set the number of minutes in the timezone offset.

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

public abstract void setYear (int year)

Added in API level 8

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.

Parameters
year value constraints are summarized in year field of date/time field mapping table. If year is FIELD_UNDEFINED, then eon is set to null.

public abstract void setYear (BigInteger year)

Added in API level 8

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.

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

Added in API level 8

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)

Parameters
timezone provide Timezone. null is a legal value.
aLocale provide explicit Locale. Use default GregorianCalendar locale if value is null.
defaults provide default field values to use when corresponding field for this instance is FIELD_UNDEFINED or null. If defaultsis null or a field within the specified defaults is undefined, just use java.util.GregorianCalendar defaults.
Returns
GregorianCalendar a java.util.GregorianCalendar conversion of this instance.

public abstract GregorianCalendar toGregorianCalendar ()

Added in API level 8

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

Field by Field Conversion from this class to java.util.GregorianCalendar
java.util.GregorianCalendar field javax.xml.datatype.XMLGregorianCalendar field
ERA getEonAndYear().signum() < 0 ? GregorianCalendar.BC : GregorianCalendar.AD
YEAR getEonAndYear().abs().intValue()*
MONTH getMonth() - JANUARY + JANUARY
DAY_OF_MONTH getDay()
HOUR_OF_DAY getHour()
MINUTE getMinute()
SECOND getSecond()
MILLISECOND get millisecond order from getFractionalSecond()*
GregorianCalendar.setTimeZone(TimeZone) getTimezone() formatted into Custom timezone id
* designates possible loss of precision during the conversion due to source datatype having higher precision than target datatype.

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)

Returns
GregorianCalendar

public String toString ()

Added in API level 8

Returns a String representation of this XMLGregorianCalendar Object.

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

Returns
String 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:

public abstract String toXMLFormat ()

Added in API level 8

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

Returns
String 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.