Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]
public interface: GDateSpecification [javadoc | source]

All Known Implementing Classes:
    GDate, GDateBuilder

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.

Field Summary
public final  int HAS_TIMEZONE    Timezone is specified. See #getFlags
public final  int HAS_YEAR    Year is specified. See #getFlags
public final  int HAS_MONTH    Month of year is specified. See #getFlags
public final  int HAS_DAY    Day of month is specified. See #getFlags
public final  int HAS_TIME    Time of day is specified. See #getFlags
Method from org.apache.xmlbeans.GDateSpecification Summary:
canonicalString,   compareToGDate,   getBuiltinTypeCode,   getCalendar,   getDate,   getDay,   getFlags,   getFraction,   getHour,   getJulianDate,   getMillisecond,   getMinute,   getMonth,   getSecond,   getTimeZoneHour,   getTimeZoneMinute,   getTimeZoneSign,   getYear,   hasDate,   hasDay,   hasMonth,   hasTime,   hasTimeZone,   hasYear,   isImmutable,   isValid,   toString
Method from org.apache.xmlbeans.GDateSpecification 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.
    • Returns -1 if this < date. (less-than)
    • Returns 0 if this == date. (equal)
    • Returns 1 if this > date. (greater-than)
    • Returns 2 if this <> date. (incomparable)
    Two instances are incomparable if they have different amounts of information.
 public int getBuiltinTypeCode()
 public XmlCalendar getCalendar()
    Retrieves the value of the current time as an XmlCalendar .

    XmlCalendar is a subclass of java.util.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 java.util.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()
 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.
 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.