Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.xml.datatype.XMLGregorianCalendar
public abstract class XMLGregorianCalendar
extends java.lang.Object
implements Cloneable
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() orgetEonAndYear()
| getYear() is a value between -(10^9-1) to (10^9)-1
or DatatypeConstants.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 DatatypeConstants.FIELD_UNDEFINED |
day | 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 | 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 | getMinute() | 0 to 59 or DatatypeConstants.FIELD_UNDEFINED |
second |
getSecond() + getMillisecond() /1000 orgetSecond() + getFractionalSecond()
|
getSecond() from 0 to 60 or DatatypeConstants.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 DatatypeConstants.FIELD_UNDEFINED .
Value range from -14 hours (-14 * 60 minutes) to 14 hours (14 * 60 minutes).
|
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:
toString()
, DatatypeFactory.newXMLGregorianCalendar(String lexicalRepresentation)
GregorianCalendar
,
toGregorianCalendar(java.util.TimeZone timezone, java.util.Locale aLocale, XMLGregorianCalendar defaults)
,
DatatypeFactory
compare(XMLGregorianCalendar xmlGregorianCalendar)
equals(Object)
defined relative to compare(XMLGregorianCalendar xmlGregorianCalendar)
.Duration
instance as defined in
W3C XML Schema 1.0 Part 2, Appendix E, Adding durations to dateTimes.
Duration
, DatatypeFactory
Method Summary | |
abstract void | |
abstract void |
|
abstract Object |
|
abstract int |
|
boolean |
|
abstract int |
|
abstract BigInteger |
|
abstract BigInteger |
|
abstract BigDecimal |
|
abstract int |
|
int |
|
abstract int |
|
abstract int |
|
abstract int |
|
abstract TimeZone |
|
abstract int |
|
abstract QName |
|
abstract int |
|
int |
|
abstract boolean |
|
abstract XMLGregorianCalendar |
|
abstract void |
|
abstract void |
|
abstract void |
|
abstract void |
|
abstract void |
|
abstract void |
|
abstract void |
|
abstract void |
|
void |
|
void |
|
void |
|
abstract void |
|
abstract void |
|
abstract void |
|
abstract GregorianCalendar |
|
abstract GregorianCalendar |
|
String |
|
abstract String |
|
public abstract void add(Duration duration)
Addduration
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.0dateTime
fields to this class' representation of those fields.
- Parameters:
duration
- Duration to add to thisXMLGregorianCalendar
.
public abstract void clear()
Unset all fields to undefined. Set all int fields toDatatypeConstants.FIELD_UNDEFINED
and reference fields to null.
public abstract Object clone()
Creates and returns a copy of this object.
- Returns:
- copy of this
Object
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 ofXMLGregorianCalendar
to compare
- Returns:
- The relationship between
this
XMLGregorianCalendar
and the specifiedxmlGregorianCalendar
asDatatypeConstants.LESSER
,DatatypeConstants.EQUAL
,DatatypeConstants.GREATER
orDatatypeConstants.INDETERMINATE
.
public boolean equals(Object obj)
Indicates whether parameterobj
is "equal to" this one.
- Parameters:
obj
- to compare.
- Returns:
true
whenobj
is an instance ofXMLGregorianCalendar
andcompare(XMLGregorianCalendar obj)
returnsDatatypeConstants.EQUAL
, otherwisefalse
.
public abstract int getDay()
Return day in month orDatatypeConstants.FIELD_UNDEFINED
. Value constraints for this value are summarized in day field of date/time field mapping table.
- See Also:
setDay(int)
public abstract BigInteger getEon()
Return high order component for XML Schema 1.0 dateTime datatype field foryear
.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:
getYear()
,getEonAndYear()
public abstract BigInteger getEonAndYear()
Return XML Schema 1.0 dateTime datatype field foryear
. Value constraints for this value are summarized in year field of date/time field mapping table.
- Returns:
- sum of
eon
andBigInteger.valueOf(year)
when both fields are defined. When onlyyear
is defined, return it. When botheon
andyear
are not defined, returnnull
.
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 bygetSecond()
, does not returnDatatypeConstants.FIELD_UNDEFINED
.
- Returns:
- fractional seconds of this
XMLGregorianCalendar
.
- See Also:
getSecond()
,setTime(int,int,int,BigDecimal)
public abstract int getHour()
Return hours orDatatypeConstants.FIELD_UNDEFINED
. ReturnsDatatypeConstants.FIELD_UNDEFINED
if this field is not defined. Value constraints for this value are summarized in hour field of date/time field mapping table.
- See Also:
setTime(int,int,int)
public int getMillisecond()
Return millisecond precision ofgetFractionalSecond()
. This method represents a convenience accessor to infinite precision fractional second value returned bygetFractionalSecond()
. The returned value is the rounded down to milliseconds value ofgetFractionalSecond()
. WhengetFractionalSecond()
returnsnull
, this method must returnDatatypeConstants.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:
getFractionalSecond()
,setTime(int,int,int)
public abstract int getMinute()
Return minutes orDatatypeConstants.FIELD_UNDEFINED
. ReturnsDatatypeConstants.FIELD_UNDEFINED
if this field is not defined. Value constraints for this value are summarized in minute field of date/time field mapping table.
- See Also:
setTime(int,int,int)
public abstract int getMonth()
Return number of month orDatatypeConstants.FIELD_UNDEFINED
. Value constraints for this value are summarized in month field of date/time field mapping table.
- Returns:
- year of this
XMLGregorianCalendar
.
public abstract int getSecond()
Return seconds orDatatypeConstants.FIELD_UNDEFINED
. ReturnsDatatypeConstants.FIELD_UNDEFINED
if this field is not defined. When this field is not defined, the optional xs:dateTime fractional seconds field, represented bygetFractionalSecond()
andgetMillisecond()
, 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
.
public abstract TimeZone getTimeZone(int defaultZoneoffset)
Returns ajava.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 isDatatypeConstants.FIELD_UNDEFINED
.
- Returns:
- TimeZone for this.
public abstract int getTimezone()
Return timezone offset in minutes orDatatypeConstants.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.
- See Also:
setTimezone(int)
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 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
- Returns:
- One of the following class constants:
DatatypeConstants.DATETIME
,DatatypeConstants.TIME
,DatatypeConstants.DATE
,DatatypeConstants.GYEARMONTH
,DatatypeConstants.GMONTHDAY
,DatatypeConstants.GYEAR
,DatatypeConstants.GMONTH
orDatatypeConstants.GDAY
.
public abstract int getYear()
Return low order component for XML Schema 1.0 dateTime datatype field foryear
orDatatypeConstants.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:
getEon()
,getEonAndYear()
public int hashCode()
Returns a hash code consistent with the definition of the equals method.
- Returns:
- hash code of this object.
public abstract boolean isValid()
Validate instance bygetXMLSchemaType()
constraints.
- Returns:
- true if data values are valid.
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.
public abstract void reset()
Reset thisXMLGregorianCalendar
to its original values.XMLGregorianCalendar
is reset to the same values as when it was created withDatatypeFactory.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)
orDatatypeFactory.newXMLGregorianCalendarTime( int hours, int minutes, int seconds, int milliseconds, int timezone)
.reset()
is designed to allow the reuse of existingXMLGregorianCalendar
s thus saving resources associated with the creation of newXMLGregorianCalendar
s.
public abstract void setDay(int day)
Set days in month. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
day
- value constraints summarized in day field of date/time field mapping table.
public abstract void setFractionalSecond(BigDecimal fractional)
Set fractional seconds. Unset this field by invoking the setter with a parameter value ofnull
.
- Parameters:
fractional
- value constraints summarized in fractional field of date/time field mapping table.
public abstract void setHour(int hour)
Set hours. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
hour
- value constraints summarized in hour field of date/time field mapping table.
public abstract void setMillisecond(int millisecond)
Set milliseconds. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
millisecond
- value constraints summarized in millisecond field of date/time field mapping table.
public abstract void setMinute(int minute)
Set minutes. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
minute
- value constraints summarized in minute field of date/time field mapping table.
public abstract void setMonth(int month)
Set month. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
month
- value constraints summarized in month field of date/time field mapping table.
public abstract void setSecond(int second)
Set seconds. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
second
- value constraints summarized in second field of date/time field mapping table.
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.
- See Also:
setTime(int,int,int,BigDecimal)
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 ofnull
indicates this optional field is not set.
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 ofDatatypeConstants.FIELD_UNDEFINED
indicates this optional field is not set.
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 ofDatatypeConstants.FIELD_UNDEFINED
.
- Parameters:
offset
- value constraints summarized in timezone field of date/time field mapping table.
public abstract void setYear(BigInteger year)
Set low and high order component of XSDdateTime
year field. Unset this field by invoking the setter with a parameter value ofnull
.
- Parameters:
year
- value constraints summarized in year field of date/time field mapping table.
public abstract void setYear(int year)
Set year of XSDdateTime
year field. Unset this field by invoking the setter with a parameter value ofDatatypeConstants.FIELD_UNDEFINED
. Note: if the absolute value of theyear
parameter is less than 10^9, the eon component of the XSD year field is set tonull
by this method.
- Parameters:
year
- value constraints are summarized in year field of date/time field mapping table. If year isDatatypeConstants.FIELD_UNDEFINED
, then eon is set tonull
.
public abstract GregorianCalendar toGregorianCalendar()
Convert thisXMLGregorianCalendar
to aGregorianCalendar
. Whenthis
instance has an undefined field, this conversion relies on thejava.util.GregorianCalendar
default for its corresponding field. A notable difference between XML Schema 1.0 date/time datatypes andjava.util.GregorianCalendar
is that Timezone value is optional for date/time datatypes and it is a required field forjava.util.GregorianCalendar
. See javadoc forjava.util.TimeZone.getDefault()
on how the default is determined. To explicitly specify theTimeZone
instance, seetoGregorianCalendar(TimeZone, Locale, XMLGregorianCalendar)
.* 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
Field by Field Conversion from this class to java.util.GregorianCalendar
java.util.GregorianCalendar
fieldjavax.xml.datatype.XMLGregorianCalendar
fieldERA
getEonAndYear()
.signum() <320 ? 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 idGregorianCalendar
should be instantiated in following manner.
- Using
timeZone
value as defined above, create a newjava.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)
public abstract GregorianCalendar toGregorianCalendar(java.util.TimeZone timezone, java.util.Locale aLocale, XMLGregorianCalendar defaults)
Convert thisXMLGregorianCalendar
along with provided parameters to aGregorianCalendar
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 withtimezone
parameter. To compute the return value'sTimeZone
field,
- when parameter
timeZone
is non-null, it is the timezone field.- else when
this.getTimezone() != FIELD_UNDEFINED
, create ajava.util.TimeZone
with a custom timezone id using thethis.getTimezone()
.- else when
defaults.getTimezone() != FIELD_UNDEFINED
, create ajava.util.TimeZone
with a custom timezone id usingdefaults.getTimezone()
.- else use the
GregorianCalendar
default timezone value for the host is defined as specified byjava.util.TimeZone.getDefault()
.GregorianCalendar
- Create a new
java.util.GregorianCalendar(TimeZone, Locale)
with TimeZone set as specified above and theLocale
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)
- Parameters:
timezone
- provide Timezone.null
is a legal value.aLocale
- provide explicit Locale. Use default GregorianCalendar locale if value isnull
.defaults
- provide default field values to use when corresponding field for this instance is FIELD_UNDEFINED or null. Ifdefaults
isnull
or a field within the specifieddefaults
is undefined, just usejava.util.GregorianCalendar
defaults.
- Returns:
- a java.util.GregorianCalendar conversion of this instance.
public String toString()
Returns aString
representation of thisXMLGregorianCalendar
Object
. The result is a lexical representation generated bytoXMLFormat()
.
- Returns:
- A non-
null
validString
representation of thisXMLGregorianCalendar
.
- See Also:
toXMLFormat()
public abstract String toXMLFormat()
Return the lexical representation ofthis
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 bygetXMLSchemaType()
.
- Returns:
- XML, as
String
, representation of thisXMLGregorianCalendar