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

 abstract public  void clear()
Unset all fields to undefined.

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

 abstract public Object clone()
Creates and returns a copy of this object.

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

 public boolean equals(Object obj) 
{
        if (obj == this) {
            return true;
        }
        if (obj instanceof XMLGregorianCalendar) {
            return compare((XMLGregorianCalendar) obj) == DatatypeConstants.EQUAL;
        }
        return false;
}

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

 abstract public int getDay()
Return day in month or DatatypeConstants#FIELD_UNDEFINED .


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

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

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

 abstract public 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 DatatypeConstants#FIELD_UNDEFINED .

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

 public int getMillisecond() 
{
		
		BigDecimal fractionalSeconds = getFractionalSecond();
		// is field undefined?
		if (fractionalSeconds == null) {
			return DatatypeConstants.FIELD_UNDEFINED;
		}
		return getFractionalSecond().movePointRight(3).intValue();
}

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

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

 abstract public int getMinute()
Return minutes or DatatypeConstants#FIELD_UNDEFINED .

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

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

 abstract public 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 
#getFractionalSecond()  and #getMillisecond() ,
must not be defined.

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

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

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

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

      
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
      

      

      

    
  

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

 public int hashCode() 
{
        // Following two dates compare to EQUALS since in different timezones.
        // 2000-01-15T12:00:00-05:00 == 2000-01-15T13:00:00-04:00 	
        //
        // Must ensure both instances generate same hashcode by normalizing 
        // this to UTC timezone.
        int timezone = getTimezone();
        if (timezone == DatatypeConstants.FIELD_UNDEFINED) {
            timezone = 0;
        }
        XMLGregorianCalendar gc = this;
        if (timezone != 0) {
            gc = this.normalize();
        }
        return gc.getYear()
        + gc.getMonth()
        + gc.getDay()
        + gc.getHour()
        + gc.getMinute()
        + gc.getSecond();
}

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

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

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

 abstract public  void reset()
Reset this XMLGregorianCalendar to its original values.

XMLGregorianCalendar is reset to the same values as when it was created with
DatatypeFactory#newXMLGregorianCalendar() ,
DatatypeFactory#newXMLGregorianCalendar(String lexicalRepresentation) ,
DatatypeFactory#newXMLGregorianCalendar(
  BigInteger year,
  int month,
  int day,
  int hour,
  int minute,
  int second,
  BigDecimal fractionalSecond,
  int timezone) ,
DatatypeFactory#newXMLGregorianCalendar(
  int year,
  int month,
  int day,
  int hour,
  int minute,
  int second,
  int millisecond,
  int timezone) ,
DatatypeFactory#newXMLGregorianCalendar(GregorianCalendar cal) ,
DatatypeFactory#newXMLGregorianCalendarDate(
  int year,
  int month,
  int day,
  int timezone) ,
DatatypeFactory#newXMLGregorianCalendarTime(
  int hours,
  int minutes,
  int seconds,
  int timezone) ,
DatatypeFactory#newXMLGregorianCalendarTime(
  int hours,
  int minutes,
  int seconds,
  BigDecimal fractionalSecond,
  int timezone)  or
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.

 abstract public  void setDay(int day)
Set days in month.

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

 abstract public  void setFractionalSecond(BigDecimal fractional)
Set fractional seconds.

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

 abstract public  void setHour(int hour)
Set hours.

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

 abstract public  void setMillisecond(int millisecond)
Set milliseconds.

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

 abstract public  void setMinute(int minute)
Set minutes.

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

 abstract public  void setMonth(int month)
Set month.

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

 abstract public  void setSecond(int second)
Set seconds.

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

 public  void setTime(int hour,
    int minute,
    int second) 
{
    	
		setTime(
			hour,
			minute,
			second,
			null // fractional
		);
}

Set time as one unit.

 public  void setTime(int hour,
    int minute,
    int second,
    BigDecimal fractional) 
{
        	
		setHour(hour);
        setMinute(minute);
        setSecond(second);
        setFractionalSecond(fractional);
}

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

 public  void setTime(int hour,
    int minute,
    int second,
    int millisecond) 
{
    	
        setHour(hour);
        setMinute(minute);
        setSecond(second);
        setMillisecond(millisecond);
}

Set time as one unit, including optional milliseconds.

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

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

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

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


  

    

      

         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()  - DatatypeConstants#JANUARY  + GregorianCalendar#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)

 abstract public 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 GregorianCalendar#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)

 public String toString() 
{
    	
    	return toXMLFormat();
}

Returns a String representation of this XMLGregorianCalendar Object.

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

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