Package org.apache.xmlbeans

Class GDuration

java.lang.Object
org.apache.xmlbeans.GDuration
All Implemented Interfaces:
Serializable, GDurationSpecification
public final class GDuration
extends Object
implements GDurationSpecification, Serializable
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.

See Also:
Serialized Form

  • Constructor Summary

    Constructors 
    Constructor Description
    GDuration()
    Constructs an empty GDuration representing zero seconds.
    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.
    GDuration​(CharSequence str)
    Constructs a GDuration from a lexical representation.
    GDuration​(GDurationSpecification gDuration)
    Constructs a GDuration from another GDurationSpecification.

  • Method Summary

    Modifier and Type Method Description
    GDuration add​(GDurationSpecification duration)
    Returns a new GDuration which is the sum of this one and the supplied duration.
    Object clone()
    Builds another GDate with the same value as this one.
    int compareToGDuration​(GDurationSpecification duration)
    Comparison to another GDuration.
    boolean equals​(Object obj)
    Two GDurations are equal if all their fields are equal.
    int getDay()
    Gets the day-of-month component.
    BigDecimal getFraction()
    Gets the fraction-of-second.
    int getHour()
    Gets the hour-of-day component.
    int getMinute()
    Gets the minute-of-hour component.
    int getMonth()
    Gets the month-of-year component.
    int getSecond()
    Gets the second-of-minute component.
    int getSign()
    Returns the sign of the duration: +1 is forwards and -1 is backwards in time.
    int getYear()
    Gets the year component.
    int hashCode()  
    boolean isImmutable()
    All GDuration instances return true.
    boolean isValid()
    Returns true if all of the individual components of the duration are nonnegative.
    GDuration subtract​(GDurationSpecification duration)
    Returns a new GDuration which is the result of subtracting the supplied duration from this one.
    String toString()
    The natural string representation of the duration.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GDuration

      public GDuration()
      Constructs an empty GDuration representing zero seconds.

    • 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).

    • GDuration

      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.
      Parameters:
      sign - +1 for a positive duration, -1 for a negative duration
      Throws:
      IllegalArgumentException - if the sign is not 1 or -1

    • GDuration

      public GDuration​(GDurationSpecification gDuration)
      Constructs a GDuration from another GDurationSpecification.

  • Method Details