- All Implemented Interfaces:
Cloneable
Representation for W3C XML Schema 1.0 date/time datatypes.
Specifically, these date/time datatypes are
DatatypeConstants.DATETIME
,
DatatypeConstants.TIME
,
DatatypeConstants.DATE
,
DatatypeConstants.GYEARMONTH
,
DatatypeConstants.GMONTHDAY
,
DatatypeConstants.GYEAR
,
DatatypeConstants.GMONTH
, and
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.
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 23 or DatatypeConstants.FIELD_UNDEFINED .
An hour value of 24 is allowed to be set in the lexical space provided the minute and second
field values are zero. However, an hour value of 24 is not allowed in value space and will be
transformed to represent the value of the first instance of the following day as per
XML Schema Part 2: Datatypes Second Edition, 3.2 Primitive datatypes.
|
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).
|
All maximum value space constraints listed for the fields in the table
above are checked by factory methods, 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:
- accessors/mutators for independent date/time fields
- conversion between this class and W3C XML Schema 1.0 lexical representation,
toString()
,DatatypeFactory.newXMLGregorianCalendar(String lexicalRepresentation)
- conversion between this class and
GregorianCalendar
,toGregorianCalendar(java.util.TimeZone timezone, java.util.Locale aLocale, XMLGregorianCalendar defaults)
,DatatypeFactory
- partial order relation comparator method,
compare(XMLGregorianCalendar xmlGregorianCalendar)
equals(Object)
defined relative tocompare(XMLGregorianCalendar xmlGregorianCalendar)
.- addition operation with
Duration
instance as defined in W3C XML Schema 1.0 Part 2, Appendix E, Adding durations to dateTimes.
- Since:
- 1.5
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
Addduration
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
Compares this calendar to the specified object.abstract int
getDay()
Returns the day of month orDatatypeConstants.FIELD_UNDEFINED
.abstract BigInteger
getEon()
Returns the high order component for XML Schema 1.0 dateTime datatype field foryear
.abstract BigInteger
Returns the XML Schema 1.0 dateTime datatype field foryear
.abstract BigDecimal
Returns fractional seconds.abstract int
getHour()
Returns the hour of day orDatatypeConstants.FIELD_UNDEFINED
if this field is not defined.int
Returns the millisecond precision ofgetFractionalSecond()
.abstract int
Returns the minute of hour orDatatypeConstants.FIELD_UNDEFINED
if this field is not defined.abstract int
getMonth()
Returns the month of this calendar orDatatypeConstants.FIELD_UNDEFINED
.abstract int
Returns the second of minute orDatatypeConstants.FIELD_UNDEFINED
if this field is not defined.abstract int
Returns the Timezone offset in minutes orDatatypeConstants.FIELD_UNDEFINED
if this optional field is not defined.abstract TimeZone
getTimeZone
(int defaultZoneoffset) Returns ajava.util.TimeZone
for this class.abstract QName
Return the name of the XML Schema date/time type that this instance maps to.abstract int
getYear()
Returns the low order component for XML Schema 1.0 dateTime datatype field foryear
orDatatypeConstants.FIELD_UNDEFINED
.int
hashCode()
Returns a hash code consistent with the definition of the equals method.abstract boolean
isValid()
Validate instance bygetXMLSchemaType()
constraints.abstract XMLGregorianCalendar
Normalize this instance to UTC.abstract void
reset()
Reset thisXMLGregorianCalendar
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) Set time as one unit.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, BigDecimal fractional) Set time as one unit, including the optional infinite precision fractional seconds.abstract void
setTimezone
(int offset) Set the number of minutes in the timezone offset.abstract void
setYear
(int year) Set year of XSDdateTime
year field.abstract void
setYear
(BigInteger year) Set low and high order component of XSDdateTime
year field.abstract GregorianCalendar
Convert thisXMLGregorianCalendar
to aGregorianCalendar
.abstract GregorianCalendar
toGregorianCalendar
(TimeZone timezone, Locale aLocale, XMLGregorianCalendar defaults) Convert thisXMLGregorianCalendar
along with provided parameters to aGregorianCalendar
instance.toString()
Returns aString
representation of thisXMLGregorianCalendar
Object
.abstract String
Return the lexical representation ofthis
instance.
-
Constructor Details
-
XMLGregorianCalendar
public XMLGregorianCalendar()Default no-arg constructor.Note: Always use the
DatatypeFactory
to construct an instance ofXMLGregorianCalendar
. The constructor on this class cannot be guaranteed to produce an object with a consistent state and may be removed in the future.
-
-
Method Details
-
clear
public abstract void clear()Unset all fields to undefined.Set all int fields to
DatatypeConstants.FIELD_UNDEFINED
and reference fields to null. -
reset
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. -
setYear
Set low and high order component of XSDdateTime
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
- ifyear
parameter is outside value constraints for the field as specified in date/time field mapping table.
-
setYear
public abstract void setYear(int year) Set year of XSDdateTime
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 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
.
-
setMonth
public abstract 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
- ifmonth
parameter is outside value constraints for the field as specified in date/time field mapping table.
-
setDay
public abstract 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
- ifday
parameter is outside value constraints for the field as specified in date/time field mapping table.
-
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
DatatypeConstants.FIELD_UNDEFINED
.- Parameters:
offset
- value constraints summarized in timezone field of date/time field mapping table.- Throws:
IllegalArgumentException
- ifoffset
parameter is outside value constraints for the field as specified in 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.- Throws:
IllegalArgumentException
- if any parameter is outside value constraints for the field as specified in date/time field mapping table.- See Also:
-
setHour
public abstract 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
- ifhour
parameter is outside value constraints for the field as specified in 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
DatatypeConstants.FIELD_UNDEFINED
.- Parameters:
minute
- value constraints summarized in minute field of date/time field mapping table.- Throws:
IllegalArgumentException
- ifminute
parameter is outside value constraints for the field as specified in 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
DatatypeConstants.FIELD_UNDEFINED
.- Parameters:
second
- value constraints summarized in second field of date/time field mapping table.- Throws:
IllegalArgumentException
- ifsecond
parameter is outside value constraints for the field as specified in 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
DatatypeConstants.FIELD_UNDEFINED
.- Parameters:
millisecond
- value constraints summarized in second field of date/time field mapping table.- Throws:
IllegalArgumentException
- ifmillisecond
parameter is outside value constraints for the field as specified in date/time field mapping table.
-
setFractionalSecond
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
- iffractional
parameter is outside value constraints for the field as specified in date/time field mapping table.
-
setTime
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.- Throws:
IllegalArgumentException
- if any parameter is outside value constraints for the field as specified in date/time field mapping table.
-
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 ofDatatypeConstants.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.
-
getEon
Returns the 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:
- The eon of this
XMLGregorianCalendar
. The value returned is an integer multiple of 10^9. - See Also:
-
getYear
public abstract int getYear()Returns the 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:
- The year of this
XMLGregorianCalendar
. - See Also:
-
getEonAndYear
Returns the XML Schema 1.0 dateTime datatype field foryear
.Value constraints for this value are summarized in year field of date/time field mapping table.
-
getMonth
public abstract int getMonth()Returns the month of this calendar orDatatypeConstants.FIELD_UNDEFINED
.Value constraints for this value are summarized in month field of date/time field mapping table.
- Returns:
- The month of this
XMLGregorianCalendar
, from 1 to 12.
-
getDay
public abstract int getDay()Returns the day of month orDatatypeConstants.FIELD_UNDEFINED
.Value constraints for this value are summarized in day field of date/time field mapping table.
- Returns:
- The day of month of this
XMLGregorianCalendar
, from 1 to 31. - See Also:
-
getTimezone
public abstract int getTimezone()Returns the 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.
- Returns:
- The Timezone offset in minutes of this
XMLGregorianCalendar
. - See Also:
-
getHour
public abstract int getHour()Returns the hour of day orDatatypeConstants.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:
- The hour of day of this
XMLGregorianCalendar
, from 0 to 23. - See Also:
-
getMinute
public abstract int getMinute()Returns the minute of hour orDatatypeConstants.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:
- The minute of hour of this
XMLGregorianCalendar
, from 0 to 59. - See Also:
-
getSecond
public abstract int getSecond()Returns the second of minute orDatatypeConstants.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:
- The second of minute of this
XMLGregorianCalendar
, from 0 to 59. - See Also:
-
getMillisecond
public int getMillisecond()Returns the millisecond precision ofgetFractionalSecond()
.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 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:
- The millisecond precision of this
XMLGregorianCalendar
. - See Also:
-
getFractionalSecond
Returns 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 returnDatatypeConstants.FIELD_UNDEFINED
.- Returns:
- Fractional seconds of this
XMLGregorianCalendar
. - See Also:
-
compare
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
. - Throws:
NullPointerException
- ifxmlGregorianCalendar
is null.
-
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.
-
equals
Compares this calendar to the specified object. The result istrue
if and only if the argument is not null and is anXMLGregorianCalendar
object that represents the same instant in time as this object.- Overrides:
equals
in classObject
- Parameters:
obj
- to compare.- Returns:
true
whenobj
is an instance ofXMLGregorianCalendar
andcompare(XMLGregorianCalendar obj)
returnsDatatypeConstants.EQUAL
, otherwisefalse
.- See Also:
-
hashCode
public int hashCode()Returns a hash code consistent with the definition of the equals method. -
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 by
getXMLSchemaType()
.- Returns:
- XML, as
String
, representation of thisXMLGregorianCalendar
- Throws:
IllegalStateException
- if the combination of set fields does not match one of the eight defined XML Schema builtin date/time datatypes.
-
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
. - Throws:
IllegalStateException
- if the combination of set fields does not match one of the eight defined XML Schema builtin date/time datatypes.
-
toString
Returns aString
representation of thisXMLGregorianCalendar
Object
.The result is a lexical representation generated by
toXMLFormat()
.- Overrides:
toString
in classObject
- Returns:
- A non-
null
validString
representation of thisXMLGregorianCalendar
. - Throws:
IllegalStateException
- if the combination of set fields does not match one of the eight defined XML Schema builtin date/time datatypes.- See Also:
-
isValid
public abstract boolean isValid()Validate instance bygetXMLSchemaType()
constraints.- Returns:
- true if data values are valid.
-
add
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.0
dateTime
fields to this class' representation of those fields.- Parameters:
duration
- Duration to add to thisXMLGregorianCalendar
.- Throws:
NullPointerException
- whenduration
parameter isnull
.
-
toGregorianCalendar
Convert thisXMLGregorianCalendar
to aGregorianCalendar
.When
this
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)
.Field by Field Conversion from this class to java.util.GregorianCalendar
java.util.GregorianCalendar
fieldjavax.xml.datatype.XMLGregorianCalendar
fieldERA
getEonAndYear()
.signum() < 0 ? GregorianCalendar.BC : GregorianCalendar.AD
YEAR
getEonAndYear()
.abs().intValue()
*MONTH
getMonth()
-DatatypeConstants.JANUARY
+Calendar.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 idTo ensure consistency in conversion implementations, the new
GregorianCalendar
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
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:
- An instance of
GregorianCalendar
. - See Also:
- Using
-
toGregorianCalendar
public abstract GregorianCalendar toGregorianCalendar(TimeZone timezone, 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 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 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()
.
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 theLocale
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)
- 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.
- when parameter
-
getTimeZone
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.
-
clone
Creates and returns a copy of this object.
-