Class Duration

public abstract Duration add(Duration rhs)

Returns the result of adding the specified duration to this duration.

public abstract void addTo(Calendar calendar)

Adds this duration to the specified calendar.

public void addTo(Date date)

Adds this duration to the specified date.

public abstract int compare(Duration duration)

Partial order relation comparison with this duration, in accordance with XML Schema 1.0 Part 2, Section 3.2.7.6.2.

public boolean equals(Object duration)

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:

equals in interface Object

Parameters:

Returns:

whether this Object is semantically equal to another

See Also:

Object.hashCode()

public int getDays()

Returns the days in this duration as an int, or 0 if not present.

public abstract Number getField(DatatypeConstants.Field field)

Returns the value of the specified field, or null if the field is undefined.

public int getHours()

Returns the hours in this duration as an int, or 0 if not present.

public int getMinutes()

Returns the minutes in this duration as an int, or 0 if not present.

public int getMonths()

Returns the months in this duration as an int, or 0 if not present.

public int getSeconds()

Returns the seconds in this duration as an int, or 0 if not present.

public abstract int getSign()

Returns the sign of this value.

public long getTimeInMillis(Calendar startInstant)

Returns the duration length in milliseconds. Because the length of a month or year may vary depending on the year, the startInstant parameter is used to specify the duration offset.

public long getTimeInMillis(Date startInstant)

Returns the duration length in milliseconds. Because the length of a month or year may vary depending on the year, the startInstant parameter is used to specify the duration offset.

public QName getXMLSchemaType()

Returns the name of the XML Schema data type this value maps to.

public int getYears()

Returns the years in this duration as an int, or 0 if not present.

public abstract int hashCode()

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:

hashCode in interface Object

Returns:

the hash code for this Object

See Also:

Object.equals(Object), System.identityHashCode(Object)

public boolean isLongerThan(Duration duration)

public abstract boolean isSet(DatatypeConstants.Field field)

Indicates whether the specified field is set.

public boolean isShorterThan(Duration duration)

public Duration multiply(int factor)

Returns the result of multiplying this duration by the given factor.

public abstract Duration multiply(BigDecimal factor)

Returns the result of multiplying this duration by the given factor.

public abstract Duration negate()

Returns the unary negative of this duration.

public abstract Duration normalizeWith(Calendar startTimeInstant)

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

public Duration subtract(Duration rhs)

Returns the result of subtracting the given duration from this duration.

public String toString()

Returns the lexical representation of this duration.

Overrides:

toString in interface Object