Duration

Duration

Duration()

add

abstract fun add(rhs: Duration!): Duration!

Computes a new duration whose value is this+rhs.

For example,

"1 day" + "-3 days" = "-2 days"
  "1 year" + "1 day" = "1 year and 1 day"
  "-(1 hour,50 minutes)" + "-20 minutes" = "-(1 hours,70 minutes)"
  "15 hours" + "-3 days" = "-(2 days,9 hours)"
  "1 year" + "-1 day" = IllegalStateException
  

Since there's no way to meaningfully subtract 1 day from 1 month, there are cases where the operation fails in IllegalStateException.

Formally, the computation is defined as follows.

Firstly, we can assume that two Durations to be added are both positive without losing generality (i.e., (-X)+Y=Y-X, X+(-Y)=X-Y, (-X)+(-Y)=-(X+Y))

Addition of two positive Durations are simply defined as field by field addition where missing fields are treated as 0.

A field of the resulting Duration will be unset if and only if respective fields of two input Durations are unset.

Note that lhs.add(rhs) will be always successful if lhs.signum()*rhs.signum()!=-1 or both of them are normalized.

addTo

abstract fun addTo(calendar: Calendar!): Unit

Adds this duration to a Calendar object.

Calls java.util.Calendar#add(int,int) in the order of YEARS, MONTHS, DAYS, HOURS, MINUTES, SECONDS, and MILLISECONDS if those fields are present. Because the Calendar class uses int to hold values, there are cases where this method won't work correctly (for example if values of fields exceed the range of int.)

Also, since this duration class is a Gregorian duration, this method will not work correctly if the given Calendar object is based on some other calendar systems.

Any fractional parts of this Duration object beyond milliseconds will be simply ignored. For example, if this duration is "P1.23456S", then 1 is added to SECONDS, 234 is added to MILLISECONDS, and the rest will be unused.

Note that because Calendar.add(int, int) is using int, Duration with values beyond the range of int in its fields will cause overflow/underflow to the given Calendar. XMLGregorianCalendar.add(Duration) provides the same basic operation as this method while avoiding the overflow/underflow issues.

addTo

open fun addTo(date: Date!): Unit

Adds this duration to a Date object.

The given date is first converted into a java.util.GregorianCalendar, then the duration is added exactly like the addTo(java.util.Calendar) method.

The updated time instant is then converted back into a Date object and used to update the given Date object.

This somewhat redundant computation is necessary to unambiguously determine the duration of months and years.

compare

abstract fun compare(duration: Duration!): Int

Partial order relation comparison with this Duration instance.

Comparison result must be in accordance with W3C XML Schema 1.0 Part 2, Section 3.2.7.6.2, Order relation on duration.

Return:

• DatatypeConstants.LESSER if this Duration is shorter than duration parameter
• DatatypeConstants.EQUAL if this Duration is equal to duration parameter
• DatatypeConstants.GREATER if this Duration is longer than duration parameter
• DatatypeConstants.INDETERMINATE if a conclusive partial order relation cannot be determined

equals

open fun equals(other: Any?): Boolean

Checks if this duration object has the same duration as another Duration object.

For example, "P1D" (1 day) is equal to "PT24H" (24 hours).

Duration X is equal to Y if and only if time instant t+X and t+Y are the same for all the test time instants specified in the section 3.2.6.2 of the XML Schema 1.0 specification.

Note that there are cases where two Durations are "incomparable" to each other, like one month and 30 days. For example,

!new Duration("P1M").isShorterThan(new Duration("P30D"))
  !new Duration("P1M").isLongerThan(new Duration("P30D"))
  !new Duration("P1M").equals(new Duration("P30D"))
  

getDays

open fun getDays(): Int

Obtains the value of the DAYS field as an integer value, or 0 if not present. This method works just like getYears() except that this method works on the DAYS field.

getField

abstract fun getField(field: DatatypeConstants.Field!): Number!

Gets the value of a field. Fields of a duration object may contain arbitrary large value. Therefore this method is designed to return a Number object. In case of YEARS, MONTHS, DAYS, HOURS, and MINUTES, the returned number will be a non-negative integer. In case of seconds, the returned number may be a non-negative decimal value.

getHours

open fun getHours(): Int

Obtains the value of the HOURS field as an integer value, or 0 if not present. This method works just like getYears() except that this method works on the HOURS field.

getMinutes

open fun getMinutes(): Int

Obtains the value of the MINUTES field as an integer value, or 0 if not present. This method works just like getYears() except that this method works on the MINUTES field.

getMonths

open fun getMonths(): Int

Obtains the value of the MONTHS field as an integer value, or 0 if not present. This method works just like getYears() except that this method works on the MONTHS field.

getSeconds

open fun getSeconds(): Int

Obtains the value of the SECONDS field as an integer value, or 0 if not present. This method works just like getYears() except that this method works on the SECONDS field.

getSign

abstract fun getSign(): Int

Returns the sign of this duration in -1,0, or 1.

getTimeInMillis

open fun getTimeInMillis(startInstant: Calendar!): Long

Returns the length of the duration in milliseconds.

If the seconds field carries more digits than millisecond order, those will be simply discarded (or in other words, rounded to zero.) For example, for any Calendar value x,

<code>new Duration("PT10.00099S").getTimeInMills(x) == 10000</code>.
  <code>new Duration("-PT10.00099S").getTimeInMills(x) == -10000</code>.
  

Note that this method uses the addTo(java.util.Calendar) method, which may work incorrectly with Duration objects with very large values in its fields. See the addTo(java.util.Calendar) method for details.

getTimeInMillis

open fun getTimeInMillis(startInstant: Date!): Long

Returns the length of the duration in milliseconds.

If the seconds field carries more digits than millisecond order, those will be simply discarded (or in other words, rounded to zero.) For example, for any Date value x,

<code>new Duration("PT10.00099S").getTimeInMills(x) == 10000</code>.
  <code>new Duration("-PT10.00099S").getTimeInMills(x) == -10000</code>.
  

Note that this method uses the addTo(java.util.Date) method, which may work incorrectly with Duration objects with very large values in its fields. See the addTo(java.util.Date) method for details.

getXMLSchemaType

open fun getXMLSchemaType(): QName!

Return the name of the XML Schema date/time type that this instance maps to. Type is computed based on fields that are set, i.e. isSet(javax.xml.datatype.DatatypeConstants.Field) == true.

getYears

open fun getYears(): Int

Get the years value of this Duration as an int or 0 if not present.

getYears() is a convenience method for getField(DatatypeConstants.YEARS).

As the return value is an int, an incorrect value will be returned for Durations with years that go beyond the range of an int. Use getField(DatatypeConstants.YEARS) to avoid possible loss of precision.

hashCode

abstract fun hashCode(): Int

Returns a hash code consistent with the definition of the equals method.

isLongerThan

open fun isLongerThan(duration: Duration!): Boolean

Checks if this duration object is strictly longer than another Duration object.

Duration X is "longer" than Y if and only if X>Y as defined in the section 3.2.6.2 of the XML Schema 1.0 specification.

For example, "P1D" (one day) > "PT12H" (12 hours) and "P2Y" (two years) > "P23M" (23 months).

isSet

abstract fun isSet(field: DatatypeConstants.Field!): Boolean

Checks if a field is set. A field of a duration object may or may not be present. This method can be used to test if a field is present.

isShorterThan

open fun isShorterThan(duration: Duration!): Boolean

Checks if this duration object is strictly shorter than another Duration object.

multiply

open fun multiply(factor: Int): Duration!

Computes a new duration whose value is factor times longer than the value of this duration.

This method is provided for the convenience. It is functionally equivalent to the following code:

multiply(new BigDecimal(String.valueOf(factor)))
  

multiply

abstract fun multiply(factor: BigDecimal!): Duration!

Computes a new duration whose value is factor times longer than the value of this duration.

For example,

"P1M" (1 month) * "12" = "P12M" (12 months)
  "PT1M" (1 min) * "0.3" = "PT18S" (18 seconds)
  "P1M" (1 month) * "1.5" = IllegalStateException
  

Since the Duration class is immutable, this method doesn't change the value of this object. It simply computes a new Duration object and returns it.

The operation will be performed field by field with the precision of BigDecimal. Since all the fields except seconds are restricted to hold integers, any fraction produced by the computation will be carried down toward the next lower unit. For example, if you multiply "P1D" (1 day) with "0.5", then it will be 0.5 day, which will be carried down to "PT12H" (12 hours). When fractions of month cannot be meaningfully carried down to days, or year to months, this will cause an IllegalStateException to be thrown. For example if you multiple one month by 0.5.

To avoid IllegalStateException, use the normalizeWith(java.util.Calendar) method to remove the years and months fields.

negate

abstract fun negate(): Duration!

Returns a new Duration object whose value is -this.

Since the Duration class is immutable, this method doesn't change the value of this object. It simply computes a new Duration object and returns it.

normalizeWith

abstract fun normalizeWith(startTimeInstant: Calendar!): Duration!

Converts the years and months fields into the days field by using a specific time instant as the reference point.

For example, duration of one month normalizes to 31 days given the start time instance "July 8th 2003, 17:40:32".

Formally, the computation is done as follows:

1. the given Calendar object is cloned
2. the years, months and days fields will be added to the Calendar object by using the Calendar.add(int,int) method
3. the difference between the two Calendars in computed in milliseconds and converted to days, if a remainder occurs due to Daylight Savings Time, it is discarded
4. the computed days, along with the hours, minutes and seconds fields of this duration object is used to construct a new Duration object.

Note that since the Calendar class uses int to hold the value of year and month, this method may produce an unexpected result if this duration object holds a very large value in the years or months fields.

subtract

open fun subtract(rhs: Duration!): Duration!

Computes a new duration whose value is this-rhs.

For example:

"1 day" - "-3 days" = "4 days"
  "1 year" - "1 day" = IllegalStateException
  "-(1 hour,50 minutes)" - "-20 minutes" = "-(1hours,30 minutes)"
  "15 hours" - "-3 days" = "3 days and 15 hours"
  "1 year" - "-1 day" = "1 year and 1 day"
  

Since there's no way to meaningfully subtract 1 day from 1 month, there are cases where the operation fails in IllegalStateException.

Formally the computation is defined as follows. First, we can assume that two Durations are both positive without losing generality. (i.e., (-X)-Y=-(X+Y), X-(-Y)=X+Y, (-X)-(-Y)=-(X-Y))

Then two durations are subtracted field by field. If the sign of any non-zero field F is different from the sign of the most significant field, 1 (if F is negative) or -1 (otherwise) will be borrowed from the next bigger unit of F.

This process is repeated until all the non-zero fields have the same sign.

If a borrow occurs in the days field (in other words, if the computation needs to borrow 1 or -1 month to compensate days), then the computation fails by throwing an IllegalStateException.

toString

open fun toString(): String

Returns a String representation of this Duration Object.

The result is formatted according to the XML Schema 1.0 specification and can be always parsed back later into the equivalent Duration Object by DatatypeFactory.newDuration(String lexicalRepresentation).

Formally, the following holds for any Duration Object x:

new Duration(x.toString()).equals(x)