Represents an XML Schema-compatible Gregorian date.
Both the immutable GDate and the mutable GDateBuilder are GDateSpecifications. Use this interface where you want to allow callers to pass any implementation of a GDate.
Related Topics
GDateBuilder
, GDate
Field Summary |
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
Method Summary |
public |
|
public int |
|
public int |
|
public |
|
public |
|
public int |
|
public int |
|
public |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public boolean |
|
public boolean |
|
public boolean |
|
public boolean |
|
public boolean |
|
public boolean |
|
public boolean |
|
public boolean |
|
public |
|
Field Detail |
public static final int HAS_DAY
GDateSpecification.getFlags()
.public static final int HAS_MONTH
GDateSpecification.getFlags()
.public static final int HAS_TIME
GDateSpecification.getFlags()
.public static final int HAS_TIMEZONE
GDateSpecification.getFlags()
.public static final int HAS_YEAR
GDateSpecification.getFlags()
.
Method Detail |
public String
canonicalString()
The canonical string representation. Specific moments or
times-of-day in a specified timezone are normalized to
UTC time to produce a canonical string form for them.
Other recurring time specifications keep their timezone
information.
public int compareToGDate(GDateSpecification
gdatespec)
Comparison to another GDate.
public int getBuiltinTypeCode()Returns the builtin type code for the shape of the information contained in this instance, or 0 if the instance doesn't contain information corresponding to a Schema type.
Value will be equal to
SchemaType.BTC_NOT_BUILTIN
,
SchemaType.BTC_G_YEAR
,
SchemaType.BTC_G_YEAR_MONTH
,
SchemaType.BTC_G_MONTH
,
SchemaType.BTC_G_MONTH_DAY
,
SchemaType.BTC_G_DAY
,
SchemaType.BTC_DATE
,
SchemaType.BTC_DATE_TIME
, or
SchemaType.BTC_TIME
.
public XmlCalendar
getCalendar()
Retrieves the value of the current time as an XmlCalendar
.
XmlCalendar
is a subclass of
GregorianCalendar
which is slightly customized to match XML schema date rules.
The returned XmlCalendar
has only those time and date fields
set that are reflected in the GDate object. Because of the way the
Calendar
contract works, any information in the isSet() vanishes
as soon as you view any unset field using get() methods.
This means that if it is important to understand which date fields
are set, you must call isSet() first before get().
public Date
getDate()
Retrieves the value of the current time as a java.util.Date
instance.
public int getDay()Gets the day-of-month. The first day of each month is 1.
public int getFlags()Returns a combination of flags indicating the information contained by this GDate. The five flags are
GDateSpecification.HAS_TIMEZONE
, GDateSpecification.HAS_YEAR
, GDateSpecification.HAS_MONTH
,
GDateSpecification.HAS_DAY
, and GDateSpecification.HAS_TIME
.
public BigDecimal
getFraction()
Gets the fraction-of-second. Range from 0 (inclusive) to 1 (exclusive).
public int getHour()Gets the hour-of-day. Midnight is 0, and 11PM is 23.
public int getJulianDate()Returns the Julian date corresponding to this Gregorian date. The Julian date (JD) is a continuous count of days from 1 January 4713 BC (= -4712 January 1).
public int getMillisecond()Gets the rounded millisecond value. Range from 0 to 999
public int getMinute()Gets the minute-of-hour. Range from 0 to 59.
public int getMonth()Gets the month-of-year. January is 1.
public int getSecond()Gets the second-of-minute. Range from 0 to 59.
public int getTimeZoneHour()Gets the time zone hour. This is always positive: for the sign, look at getTimeZoneSign().
public int getTimeZoneMinute()Gets the time zone minutes. This is always positive: for the sign, look at getTimeZoneSign().
public int getTimeZoneSign()Gets the time zone sign. For time zones east of GMT, this is positive; for time zones west, this is negative.
public int getYear()Gets the year. Should be a four-digit year specification.
public boolean hasDate()True if this date/time specification specifies a full date (year, month, day)
public boolean hasDay()True if this date/time specification specifies a day-of-month.
public boolean hasMonth()True if this date/time specification specifies a month-of-year.
public boolean hasTime()True if this date/time specification specifies a time-of-day.
public boolean hasTimeZone()True if this date/time specification specifies a timezone.
public boolean hasYear()True if this date/time specification specifies a year.
public boolean isImmutable()True if this GDate specification is immutable. GDate returns true, and GDateBuilder returns false.
public boolean isValid()True if this GDate corresponds to a valid gregorian date value in XML schema.
public String
toString()
The natural string representation. This represents the information
that is available, including timezone. For types that correspond
to defined schema types (schemaBuiltinTypeCode() > 0),
this provides the natural lexical representation.
When both time and timezone are specified, this string is not
the canonical representation unless the timezone is UTC (Z)
(since the same moment in time can be expressed in different
timezones). To get a canonical string, use the canonicalString()
method.
Object.toString()