Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]
public final class: GDuration [javadoc | source]

All Implemented Interfaces:
    java$io$Serializable, GDurationSpecification

Represents an XML Schema-compatible duration.

A duration is made up of a number of years, months, days, hours, minutes, seconds, and fractions of seconds. See the XML Schema specification section on xs:duration for details on the rules for comparing durations and adding durations to dates.
 public GDuration() 
 public GDuration(CharSequence str) 
    Constructs a GDuration from a lexical representation. The lexical space contains the union of the lexical spaces of all the schema date/time types (except for duration).
 public GDuration(GDurationSpecification gDuration) 
    Constructs a GDuration from another GDurationSpecification.
 public GDuration(int sign,
    int year,
    int month,
    int day,
    int hour,
    int minute,
    int second,
    BigDecimal fraction) 
    Constructs a GDuration with the specified sign, year, month, day, hours, minutes, seconds, and optional fractional seconds.
    sign - +1 for a positive duration, -1 for a negative duration
    java.lang.IllegalArgumentException - if the sign is not 1 or -1
Method from org.apache.xmlbeans.GDuration Summary:
add,   clone,   compareToGDuration,   equals,   getDay,   getFraction,   getHour,   getMinute,   getMonth,   getSecond,   getSign,   getYear,   hashCode,   isImmutable,   isValid,   subtract,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xmlbeans.GDuration Detail:
 public GDuration add(GDurationSpecification duration) 
    Returns a new GDuration which is the sum of this one and the supplied duration. Does a fieldwise addition, with no normalization.
 public Object clone() 
    Builds another GDate with the same value as this one.
 public final int compareToGDuration(GDurationSpecification duration) 
    Comparison to another GDuration.
    • Returns -1 if this < duration. (less-than)
    • Returns 0 if this == duration. (equal)
    • Returns 1 if this > duration. (greater-than)
    • Returns 2 if this <> duration. (incomparable)
    Two instances are incomparable if they have different amounts of information.
 public boolean equals(Object obj) 
    Two GDurations are equal if all their fields are equal. The equals function does not apply normalizatin.
 public final int getDay() 
    Gets the day-of-month component.
 public BigDecimal getFraction() 
    Gets the fraction-of-second. Range from 0 (inclusive) to 1 (exclusive).
 public final int getHour() 
    Gets the hour-of-day component.
 public final int getMinute() 
    Gets the minute-of-hour component.
 public final int getMonth() 
    Gets the month-of-year component.
 public final int getSecond() 
    Gets the second-of-minute component.
 public final int getSign() 
    Returns the sign of the duration: +1 is forwards and -1 is backwards in time.
 public final int getYear() 
    Gets the year component.
 public int hashCode() 
 public final boolean isImmutable() 
    All GDuration instances return true.
 public boolean isValid() 
    Returns true if all of the individual components of the duration are nonnegative.
 public GDuration subtract(GDurationSpecification duration) 
    Returns a new GDuration which is the result of subtracting the supplied duration from this one. Does a fieldwise subtraction, with no normalization.
 public String toString() 
    The natural string representation of the duration.

    Any components that are zero are omitted. Note that if the duration is invalid, i.e., it has negative components, those negative components are serialized out here. To check for validity, use the isValid() method; and to normalize most durations to a valid form use the normalize() method.