Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]
org.apache.xmlbeans
public final class: GDate [javadoc | source]
java.lang.Object
   org.apache.xmlbeans.GDate

All Implemented Interfaces:
    java$io$Serializable, GDateSpecification

Represents an XML Schema-compatible Gregorian date.

There are many date types in XML Schema, and this type represents the natural union of all those types. A GDate can hold any subset of date fields (Year, Month, Day, Time, Timezone, or some combination). Wherever the specification provides guidance, the guidelines in the XML Schema 1.0 specification (plus published errata) are followed.

Instances may separately have values or no values for the year, month, day-of-month, and time-of-day. Not all operations are meaningful on all combinations.
Field Summary
static final  int MAX_YEAR     
static final  int MIN_YEAR     
static final  BigDecimal _zero     
static final  BigDecimal _one     
Constructor:
 public GDate(CharSequence string) 
    Constructs a GDate based on a lexical representation.
 public GDate(Date date) 
    Constructs a GDate based on a java.util.Date.

    The current offset of the default timezone is used as the timezone.

    For example, if eastern daylight time is in effect at the given date, the timezone on the east coast of the united states translates to GMT-05:00 (EST) + 1:00 (DT offset) == GMT-04:00.

 public GDate(Calendar calendar) 
    Constructs a GDate based on a java.util.Calendar.

    If the calendar does not have some fields set, the same absence of information is reflected in the GDate. Note that java.util.GregorianCalendar fills in all fields as soon as any are fetched, so constructing a GDate with the same calendar object twice may result in a different GDate because of a changed calendar. Note that org.apache.xmlbeans.XmlCalendar is stable if you re-get a set field, so it does not have the same problem.

 public GDate(GDateSpecification gdate) 
    Constructs a GDate based on another GDateSpecification.
 public GDate(int year,
    int month,
    int day,
    int hour,
    int minute,
    int second,
    BigDecimal fraction) 
    Constructs a GDate with the specified year, month, day, hours, minutes, seconds, and optional fractional seconds, in an unspecified timezone.

    Note that by not specifying the timezone the GDate becomes partially unordered with respect to times that do have a specified timezone.

 public GDate(int year,
    int month,
    int day,
    int hour,
    int minute,
    int second,
    BigDecimal fraction,
    int tzSign,
    int tzHour,
    int tzMinute) 
    Constructs an absolute GDate with the specified year, month, day, hours, minutes, seconds, and optional fractional seconds, and in the timezone specified.

    If you wish to have a time or date that isn't in a specified timezone, then use the constructor that does not include the timezone arguments.

Method from org.apache.xmlbeans.GDate Summary:
add,   canonicalString,   compareToGDate,   digitVal,   equals,   formatGDate,   getBuiltinTypeCode,   getCalendar,   getDate,   getDay,   getFlags,   getFraction,   getHour,   getJulianDate,   getMillisecond,   getMinute,   getMonth,   getSecond,   getTimeZoneHour,   getTimeZoneMinute,   getTimeZoneSign,   getYear,   hasDate,   hasDay,   hasMonth,   hasTime,   hasTimeZone,   hasYear,   hashCode,   isDigit,   isImmutable,   isSpace,   isValid,   subtract,   timeZoneForGDate,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xmlbeans.GDate Detail:
 public GDate add(GDurationSpecification duration) 
    Adds a duration to this GDate, and returns a new GDate.
 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 datespec) 
    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.
 static final int digitVal(char ch) 
 public boolean equals(Object obj) 
    GDate is an immutable class, and equality is computed based on its canonical value.
 static String formatGDate(GDateSpecification spec) 
 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 final 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 HAS_TIMEZONE, HAS_YEAR, HAS_MONTH, HAS_DAY, and HAS_TIME.
 public final BigDecimal getFraction() 
    Gets the fraction-of-second. Range from 0 (inclusive) to 1 (exclusive).
 public final 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 final int getMinute() 
    Gets the minute-of-hour. Range from 0 to 59.
 public final int getMonth() 
    Gets the month-of-year. January is 1.
 public final int getSecond() 
    Gets the second-of-minute. Range from 0 to 59.
 public final int getTimeZoneHour() 
    Gets the time zone hour. This is always positive: for the sign, look at getTimeZoneSign().
 public final int getTimeZoneMinute() 
    Gets the time zone minutes. This is always positive: for the sign, look at getTimeZoneSign().
 public final int getTimeZoneSign() 
    Gets the time zone sign. For time zones east of GMT, this is positive; for time zones west, this is negative.
 public final int getYear() 
    Gets the year. Should be a four-digit year specification.
 public final boolean hasDate() 
    True if this date/time specification specifies a full date (year, month, day)
 public final boolean hasDay() 
    True if this date/time specification specifies a day-of-month.
 public final boolean hasMonth() 
    True if this date/time specification specifies a month-of-year.
 public final boolean hasTime() 
    True if this date/time specification specifies a time-of-day.
 public final boolean hasTimeZone() 
    True if this date/time specification specifies a timezone.
 public final boolean hasYear() 
    True if this date/time specification specifies a year.
 public int hashCode() 
    Returns a hash code for this GDate.
 static final boolean isDigit(char ch) 
 public final boolean isImmutable() 
    Returns true: all GDate instances are immutable.
 static final boolean isSpace(char ch) 
 public boolean isValid() 
    True if this GDate corresponds to a valid gregorian date value in XML schema.
 public GDate subtract(GDurationSpecification duration) 
    Adds a duration to this GDate, and returns a new GDate.
 static final TimeZone timeZoneForGDate(GDateSpecification date) 
 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.