This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.datatype
class XMLGregorianCalendar

java.lang.Object extended by javax.xml.datatype.XMLGregorianCalendar
All Implemented Interfaces:
Cloneable

Most common ways to construct:

DatatypeFactory factory = …;

XMLGregorianCalendar startTime = factory.newXMLGregorianCalendar();

Based on 16 examples

 

DatatypeFactory factory = …;
String timeString1 = …;

XMLGregorianCalendar time1 = factory.newXMLGregorianCalendar(timeString1);

Based on 14 examples


public abstract class XMLGregorianCalendar
extends Object
implements Cloneable

Representation for W3C XML Schema 1.0 date/time datatypes. Specifically, these date/time datatypes are {@link DatatypeConstants#DATETIME}, {@link DatatypeConstants#TIME}, {@link DatatypeConstants#DATE}, {@link DatatypeConstants#GYEARMONTH}, {@link DatatypeConstants#GMONTHDAY}, {@link DatatypeConstants#GYEAR}, {@link DatatypeConstants#GMONTH}, and {@link DatatypeConstants#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 {@link #getYear()} + {@link #getEon()} or
{@link #getEonAndYear}
getYear() is a value between -(10^9-1) to (10^9)-1 or {@link DatatypeConstants#FIELD_UNDEFINED}.
{@link #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 {@link #getMonth()} 1 to 12 or {@link DatatypeConstants#FIELD_UNDEFINED}
day {@link #getDay()} Independent of month, max range is 1 to 31 or {@link 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 {@link #getHour()} 0 to 24 or {@link DatatypeConstants#FIELD_UNDEFINED}. For a value of 24, the minute and second field must be zero per XML Schema Errata.
minute {@link #getMinute()} 0 to 59 or {@link DatatypeConstants#FIELD_UNDEFINED}
second {@link #getSecond()} + {@link #getMillisecond()}/1000 or
{@link #getSecond()} + {@link #getFractionalSecond()}
{@link #getSecond()} from 0 to 60 or {@link DatatypeConstants#FIELD_UNDEFINED}.
(Note: 60 only allowable for leap second.)
{@link #getFractionalSecond()} allows for infinite precision over the range from 0.0 to 1.0 when the {@link #getSecond()} is defined.
FractionalSecond is optional and has a value of null when it is undefined.
{@link #getMillisecond()} is the convenience millisecond precision of value of {@link #getFractionalSecond()}.
timezone {@link #getTimezone()} Number of minutes or {@link DatatypeConstants#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:


Constructor Summary

          Default no-arg constructor.
 
Method Summary
abstract void
add(Duration duration)

          Add duration to this instance.
abstract void

          Unset all fields to undefined.
abstract Object

          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

          Compares this calendar to the specified object.
abstract int

          Return day in month or javax.xml.datatype.DatatypeConstants.FIELD_UNDEFINED.
abstract BigInteger

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

          Return XML Schema 1.0 dateTime datatype field for year.
abstract BigDecimal

          Return fractional seconds.
abstract int

          Return hours or javax.xml.datatype.DatatypeConstants.FIELD_UNDEFINED.
 int

          Return millisecond precision of javax.xml.datatype.XMLGregorianCalendar.getFractionalSecond.
abstract int

          Return minutes or javax.xml.datatype.DatatypeConstants.FIELD_UNDEFINED.
abstract int

          Return number of month or javax.xml.datatype.DatatypeConstants.FIELD_UNDEFINED.
abstract int

          Return seconds or javax.xml.datatype.DatatypeConstants.FIELD_UNDEFINED.
abstract int

          Return timezone offset in minutes or javax.xml.datatype.DatatypeConstants.FIELD_UNDEFINED if this optional field is not defined.
abstract TimeZone
getTimeZone(int defaultZoneoffset)

          Returns a java.util.TimeZone for this class.
abstract QName

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

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

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

          Validate instance by getXMLSchemaType() constraints.
abstract XMLGregorianCalendar

          Normalize this instance to UTC.
abstract void

          Reset this XMLGregorianCalendar to its original values.
abstract void
setDay(int day)

          Set days in month.
abstract void

          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)

          Set time as one unit.
 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.
abstract void
setTimezone(int offset)

          Set the number of minutes in the timezone offset.
abstract void

          Set low and high order component of XSD dateTime year field.
abstract void
setYear(int year)

          Set year of XSD dateTime year field.
abstract GregorianCalendar

          Convert this XMLGregorianCalendar to a java.util.GregorianCalendar.
abstract GregorianCalendar

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

          Returns a String representation of this XMLGregorianCalendar Object.
abstract String

          Return the lexical representation of this instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLGregorianCalendar

public XMLGregorianCalendar()
Default no-arg constructor.

Note: Always use the {@link DatatypeFactory} to construct an instance of XMLGregorianCalendar. The constructor on this class cannot be guaranteed to produce an object with a consistent state and may be removed in the future.

Method Detail

add

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

clear

public abstract void clear()

Unset all fields to undefined.

Set all int fields to {@link DatatypeConstants#FIELD_UNDEFINED} and reference fields to null.


clone

public abstract Object clone()

Creates and returns a copy of this object.

Overrides:
clone in class Object
Returns:
copy of this Object

compare

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

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:
The relationship between this XMLGregorianCalendar and the specified xmlGregorianCalendar as {@link DatatypeConstants#LESSER}, {@link DatatypeConstants#EQUAL}, {@link DatatypeConstants#GREATER} or {@link DatatypeConstants#INDETERMINATE}.

equals

public boolean equals(Object obj)

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.

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

getDay

public abstract int getDay()
Return day in month or {@link DatatypeConstants#FIELD_UNDEFINED}.

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


getEon

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

Returns:
eon of this XMLGregorianCalendar. The value returned is an integer multiple of 10^9.

getEonAndYear

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

getFractionalSecond

public abstract 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 {@link #getSecond()}, does not return {@link DatatypeConstants#FIELD_UNDEFINED}.

Returns:
fractional seconds of this XMLGregorianCalendar.

getHour

public abstract int getHour()
Return hours or {@link DatatypeConstants#FIELD_UNDEFINED}. Returns {@link DatatypeConstants#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

public int getMillisecond()

Return millisecond precision of {@link #getFractionalSecond()}.

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

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

Returns:
Millisecond of this XMLGregorianCalendar.

getMinute

public abstract int getMinute()
Return minutes or {@link DatatypeConstants#FIELD_UNDEFINED}.

Returns {@link DatatypeConstants#FIELD_UNDEFINED} if this field is not defined.

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


getMonth

public abstract int getMonth()

Return number of month or {@link DatatypeConstants#FIELD_UNDEFINED}.

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

Returns:
year of this XMLGregorianCalendar.

getSecond

public abstract int getSecond()

Return seconds or {@link DatatypeConstants#FIELD_UNDEFINED}.

Returns {@link DatatypeConstants#FIELD_UNDEFINED} if this field is not defined. When this field is not defined, the optional xs:dateTime fractional seconds field, represented by {@link #getFractionalSecond()} and {@link #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.

getTimezone

public abstract int getTimezone()
Return timezone offset in minutes or {@link DatatypeConstants#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.


getTimeZone

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

Parameters:
defaultZoneoffset - default zoneoffset if this zoneoffset is {@link DatatypeConstants#FIELD_UNDEFINED}.
Returns:
TimeZone for this.

getXMLSchemaType

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

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
{@link DatatypeConstants#DATETIME} X X X X X X
{@link DatatypeConstants#DATE} X X X
{@link DatatypeConstants#TIME} X X X
{@link DatatypeConstants#GYEARMONTH} X X
{@link DatatypeConstants#GMONTHDAY} X X
{@link DatatypeConstants#GYEAR} X
{@link DatatypeConstants#GMONTH} X
{@link DatatypeConstants#GDAY} X

Returns:
One of the following class constants: {@link DatatypeConstants#DATETIME}, {@link DatatypeConstants#TIME}, {@link DatatypeConstants#DATE}, {@link DatatypeConstants#GYEARMONTH}, {@link DatatypeConstants#GMONTHDAY}, {@link DatatypeConstants#GYEAR}, {@link DatatypeConstants#GMONTH} or {@link DatatypeConstants#GDAY}.

getYear

public abstract int getYear()

Return low order component for XML Schema 1.0 dateTime datatype field for year or {@link DatatypeConstants#FIELD_UNDEFINED}.

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

Returns:
year of this XMLGregorianCalendar.

hashCode

public int hashCode()

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

Overrides:
hashCode in class Object
Returns:
hash code of this object.

isValid

public abstract boolean isValid()
Validate instance by getXMLSchemaType() constraints.

Returns:
true if data values are valid.

normalize

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

reset

public abstract void reset()

Reset this XMLGregorianCalendar to its original values.

XMLGregorianCalendar is reset to the same values as when it was created with {@link DatatypeFactory#newXMLGregorianCalendar()}, {@link DatatypeFactory#newXMLGregorianCalendar(String lexicalRepresentation)}, {@link DatatypeFactory#newXMLGregorianCalendar( BigInteger year, int month, int day, int hour, int minute, int second, BigDecimal fractionalSecond, int timezone)}, {@link DatatypeFactory#newXMLGregorianCalendar( int year, int month, int day, int hour, int minute, int second, int millisecond, int timezone)}, {@link DatatypeFactory#newXMLGregorianCalendar(GregorianCalendar cal)}, {@link DatatypeFactory#newXMLGregorianCalendarDate( int year, int month, int day, int timezone)}, {@link DatatypeFactory#newXMLGregorianCalendarTime( int hours, int minutes, int seconds, int timezone)}, {@link DatatypeFactory#newXMLGregorianCalendarTime( int hours, int minutes, int seconds, BigDecimal fractionalSecond, int timezone)} or {@link DatatypeFactory#newXMLGregorianCalendarTime( int hours, int minutes, int seconds, int milliseconds, int timezone)}.

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


setDay

public abstract void setDay(int day)

Set days in month.

Unset this field by invoking the setter with a parameter value of {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
day - value constraints summarized in day field of date/time field mapping table.

setFractionalSecond

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

setHour

public abstract void setHour(int hour)

Set hours.

Unset this field by invoking the setter with a parameter value of {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
hour - value constraints summarized in hour field of date/time field mapping table.

setMillisecond

public abstract void setMillisecond(int millisecond)

Set milliseconds.

Unset this field by invoking the setter with a parameter value of {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
millisecond - value constraints summarized in second field of date/time field mapping table.

setMinute

public abstract void setMinute(int minute)

Set minutes.

Unset this field by invoking the setter with a parameter value of {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
minute - value constraints summarized in minute field of date/time field mapping table.

setMonth

public abstract void setMonth(int month)

Set month.

Unset this field by invoking the setter with a parameter value of {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
month - value constraints summarized in month field of date/time field mapping table.

setSecond

public abstract void setSecond(int second)

Set seconds.

Unset this field by invoking the setter with a parameter value of {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
second - value constraints summarized in second field of date/time field mapping table.

setTime

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

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.

setTime

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.

setTime

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

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 {@link DatatypeConstants#FIELD_UNDEFINED} indicates this optional field is not set.

setTimezone

public abstract 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 {@link DatatypeConstants#FIELD_UNDEFINED}.

Parameters:
offset - value constraints summarized in timezone field of date/time field mapping table.

setYear

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

setYear

public abstract void setYear(int year)

Set year of XSD dateTime year field.

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

toGregorianCalendar

public abstract GregorianCalendar toGregorianCalendar()

Convert this XMLGregorianCalendar to a {@link 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 {@link #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 {@link #getEonAndYear()}.signum() < 0 ? GregorianCalendar.BC : GregorianCalendar.AD
YEAR {@link #getEonAndYear()}.abs().intValue()*
MONTH {@link #getMonth()} - {@link DatatypeConstants#JANUARY} + {@link GregorianCalendar#JANUARY}
DAY_OF_MONTH {@link #getDay()}
HOUR_OF_DAY {@link #getHour()}
MINUTE {@link #getMinute()}
SECOND {@link #getSecond()}
MILLISECOND get millisecond order from {@link #getFractionalSecond()}*
GregorianCalendar.setTimeZone(TimeZone) {@link #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.


toGregorianCalendar

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

Convert this XMLGregorianCalendar along with provided parameters to a {@link 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,


toString

public String toString()

Returns a String representation of this XMLGregorianCalendar Object.

The result is a lexical representation generated by {@link #toXMLFormat()}.

Overrides:
toString in class Object
Returns:
A non-null valid String representation of this XMLGregorianCalendar.

toXMLFormat

public abstract 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 {@link #getXMLSchemaType()}.

Returns:
XML, as String, representation of this XMLGregorianCalendar


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.