|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.xml.datatype.XMLGregorianCalendar
public abstract class XMLGregorianCalendar
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.
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).
|
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:
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
Constructor Summary | |
---|---|
XMLGregorianCalendar()
Default no-arg constructor. |
Method Summary | |
---|---|
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)
Compares this calendar to the specified object. |
abstract int |
getDay()
Return day in month or DatatypeConstants.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 DatatypeConstants.FIELD_UNDEFINED . |
int |
getMillisecond()
Return millisecond precision of getFractionalSecond() . |
abstract int |
getMinute()
Return minutes or DatatypeConstants.FIELD_UNDEFINED . |
abstract int |
getMonth()
Return number of month or DatatypeConstants.FIELD_UNDEFINED . |
abstract int |
getSecond()
Return seconds or DatatypeConstants.FIELD_UNDEFINED . |
abstract int |
getTimezone()
Return timezone offset in minutes or 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 |
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 DatatypeConstants.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)
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 |
setYear(BigInteger year)
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 |
toGregorianCalendar()
Convert this XMLGregorianCalendar to a GregorianCalendar . |
abstract GregorianCalendar |
toGregorianCalendar(TimeZone timezone,
Locale aLocale,
XMLGregorianCalendar defaults)
Convert this XMLGregorianCalendar along with provided parameters
to a GregorianCalendar instance. |
String |
toString()
Returns a String representation of this XMLGregorianCalendar Object . |
abstract String |
toXMLFormat()
Return the lexical representation of this instance. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XMLGregorianCalendar()
Note: Always use the 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 |
---|
public abstract void clear()
Unset all fields to undefined.
Set all int fields to DatatypeConstants.FIELD_UNDEFINED
and reference fields
to null.
public abstract 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 XMLGregorianCalendar
s
thus saving resources associated with the creation of new XMLGregorianCalendar
s.
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
.
year
- value constraints summarized in year field of date/time field mapping table.
IllegalArgumentException
- if year
parameter is
outside value constraints for the field as specified in
date/time field mapping table.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
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.
year
- value constraints are summarized in year field of date/time field mapping table.
If year is DatatypeConstants.FIELD_UNDEFINED
, then eon is set to null
.public abstract void setMonth(int month)
Set month.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
month
- value constraints summarized in month field of date/time field mapping table.
IllegalArgumentException
- if month
parameter is
outside value constraints for the field as specified in
date/time field mapping table.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
.
day
- value constraints summarized in day field of date/time field mapping table.
IllegalArgumentException
- if day
parameter is
outside value constraints for the field as specified in
date/time field mapping table.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
.
offset
- value constraints summarized in
timezone field of date/time field mapping table.
IllegalArgumentException
- if offset
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)
Set time as one unit.
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.
IllegalArgumentException
- if any parameter is
outside value constraints for the field as specified in
date/time field mapping table.setTime(int, int, int, BigDecimal)
public abstract void setHour(int hour)
Set hours.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
hour
- value constraints summarized in hour field of date/time field mapping table.
IllegalArgumentException
- if hour
parameter is outside value constraints for the field as specified in
date/time field mapping table.public abstract void setMinute(int minute)
Set minutes.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
minute
- value constraints summarized in minute field of date/time field mapping table.
IllegalArgumentException
- if minute
parameter is outside value constraints for the field as specified in
date/time field mapping table.public abstract void setSecond(int second)
Set seconds.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
second
- value constraints summarized in second field of date/time field mapping table.
IllegalArgumentException
- if second
parameter is outside value constraints for the field as specified in
date/time field mapping table.public abstract void setMillisecond(int millisecond)
Set milliseconds.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
millisecond
- value constraints summarized in
second field of date/time field mapping table.
IllegalArgumentException
- if millisecond
parameter is outside value constraints for the field as specified
in 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 of null
.
fractional
- value constraints summarized in
second field of date/time field mapping table.
IllegalArgumentException
- if fractional
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)
Set time as one unit, including the optional infinite precision fractional seconds.
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.
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)
Set time as one unit, including optional milliseconds.
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 DatatypeConstants.FIELD_UNDEFINED
indicates this
optional field is not set.
IllegalArgumentException
- if any parameter is
outside value constraints for the field as specified in
date/time field mapping table.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.
XMLGregorianCalendar
. The value
returned is an integer multiple of 10^9.getYear()
,
getEonAndYear()
public abstract 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.
XMLGregorianCalendar
.getEon()
,
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.
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
.getEon()
,
getYear()
public abstract 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.
XMLGregorianCalendar
.public abstract int getDay()
DatatypeConstants.FIELD_UNDEFINED
.
Value constraints for this value are summarized in day field of date/time field mapping table.
setDay(int)
public abstract int getTimezone()
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.
setTimezone(int)
public abstract int getHour()
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.
setTime(int, int, int)
public abstract int getMinute()
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.
setTime(int, int, int)
public abstract 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.
XMLGregorianCalendar
.getFractionalSecond()
,
getMillisecond()
,
setTime(int, int, int)
public int getMillisecond()
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.
XMLGregorianCalendar
.getFractionalSecond()
,
setTime(int, int, int)
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 getSecond()
,
does not return DatatypeConstants.FIELD_UNDEFINED
.
XMLGregorianCalendar
.getSecond()
,
setTime(int, int, int, BigDecimal)
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.
xmlGregorianCalendar
- Instance of XMLGregorianCalendar
to compare
this
XMLGregorianCalendar
and
the specified xmlGregorianCalendar
as
DatatypeConstants.LESSER
,
DatatypeConstants.EQUAL
,
DatatypeConstants.GREATER
or
DatatypeConstants.INDETERMINATE
.
NullPointerException
- if xmlGregorianCalendar
is null.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).
this
XMLGregorianCalendar
normalized to UTC.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.
equals
in class Object
obj
- to compare.
true
when obj
is an instance of
XMLGregorianCalendar
and
compare(XMLGregorianCalendar obj)
returns DatatypeConstants.EQUAL
,
otherwise false
.Object.hashCode()
,
Hashtable
public int hashCode()
Returns a hash code consistent with the definition of the equals method.
hashCode
in class Object
Object.equals(java.lang.Object)
,
Hashtable
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
getXMLSchemaType()
.
String
, representation of this XMLGregorianCalendar
IllegalStateException
- if the combination of set fields
does not match one of the eight defined XML Schema builtin date/time datatypes.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 |
DatatypeConstants.DATETIME
,
DatatypeConstants.TIME
,
DatatypeConstants.DATE
,
DatatypeConstants.GYEARMONTH
,
DatatypeConstants.GMONTHDAY
,
DatatypeConstants.GYEAR
,
DatatypeConstants.GMONTH
or
DatatypeConstants.GDAY
.
IllegalStateException
- if the combination of set fields
does not match one of the eight defined XML Schema builtin
date/time datatypes.public String toString()
Returns a String
representation of this XMLGregorianCalendar
Object
.
The result is a lexical representation generated by toXMLFormat()
.
toString
in class Object
null
valid String
representation of this XMLGregorianCalendar
.
IllegalStateException
- if the combination of set fields
does not match one of the eight defined XML Schema builtin date/time datatypes.toXMLFormat()
public abstract boolean isValid()
getXMLSchemaType()
constraints.
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.
duration
- Duration to add to this XMLGregorianCalendar
.
NullPointerException
- when duration
parameter is null
.public abstract 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 + 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 id |
To ensure consistency in conversion implementations, the new
GregorianCalendar
should be instantiated in following
manner.
timeZone
value as defined above, create a new
java.util.GregorianCalendar(timeZone,Locale.getDefault())
.
Calendar.clear()
.GregorianCalendar.setGregorianChange(
new Date(Long.MIN_VALUE))
.Calendar.set(int,int)
toGregorianCalendar(java.util.TimeZone, java.util.Locale, XMLGregorianCalendar)
public abstract 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,
timeZone
is non-null,
it is the timezone field.this.getTimezone() != FIELD_UNDEFINED
,
create a java.util.TimeZone
with a custom timezone id
using the this.getTimezone()
.defaults.getTimezone() != FIELD_UNDEFINED
,
create a java.util.TimeZone
with a custom timezone id
using defaults.getTimezone()
.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.
java.util.GregorianCalendar(TimeZone,
Locale)
with TimeZone set as specified above and the
Locale
parameter.
Calendar.clear()
GregorianCalendar.setGregorianChange(
new Date(Long.MIN_VALUE))
.Calendar.set(int,int)
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 defaults
is null
or a field
within the specified defaults
is undefined,
just use java.util.GregorianCalendar
defaults.
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).
defaultZoneoffset
- default zoneoffset if this zoneoffset is
DatatypeConstants.FIELD_UNDEFINED
.
public abstract Object clone()
Creates and returns a copy of this object.
clone
in class Object
Object
Cloneable
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.