javax.xml.datatype

Class Duration

public abstract class Duration extends Object

An immutable time space as specified in XML Schema 1.0.

Since: 1.5

Method Summary
abstract Durationadd(Duration rhs)
Returns the result of adding the specified duration to this duration.
abstract voidaddTo(Calendar calendar)
Adds this duration to the specified calendar.
voidaddTo(Date date)
Adds this duration to the specified date.
abstract intcompare(Duration duration)
Partial order relation comparison with this duration, in accordance with XML Schema 1.0 Part 2, Section 3.2.7.6.2.
booleanequals(Object duration)
intgetDays()
Returns the days in this duration as an int, or 0 if not present.
abstract NumbergetField(DatatypeConstants.Field field)
Returns the value of the specified field, or null if the field is undefined.
intgetHours()
Returns the hours in this duration as an int, or 0 if not present.
intgetMinutes()
Returns the minutes in this duration as an int, or 0 if not present.
intgetMonths()
Returns the months in this duration as an int, or 0 if not present.
intgetSeconds()
Returns the seconds in this duration as an int, or 0 if not present.
abstract intgetSign()
Returns the sign of this value.
longgetTimeInMillis(Calendar startInstant)
Returns the duration length in milliseconds.
longgetTimeInMillis(Date startInstant)
Returns the duration length in milliseconds.
QNamegetXMLSchemaType()
Returns the name of the XML Schema data type this value maps to.
intgetYears()
Returns the years in this duration as an int, or 0 if not present.
abstract inthashCode()
booleanisLongerThan(Duration duration)
abstract booleanisSet(DatatypeConstants.Field field)
Indicates whether the specified field is set.
booleanisShorterThan(Duration duration)
Durationmultiply(int factor)
Returns the result of multiplying this duration by the given factor.
abstract Durationmultiply(BigDecimal factor)
Returns the result of multiplying this duration by the given factor.
abstract Durationnegate()
Returns the unary negative of this duration.
abstract DurationnormalizeWith(Calendar startTimeInstant)
Converts the years and months fields into the days field using a specific time instant as the reference point.
Durationsubtract(Duration rhs)
Returns the result of subtracting the given duration from this duration.
StringtoString()
Returns the lexical representation of this duration.

Method Detail

add

public abstract Duration add(Duration rhs)
Returns the result of adding the specified duration to this duration.

addTo

public abstract void addTo(Calendar calendar)
Adds this duration to the specified calendar.

addTo

public void addTo(Date date)
Adds this duration to the specified date.

compare

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.

equals

public boolean equals(Object duration)

getDays

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

getField

public abstract Number getField(DatatypeConstants.Field field)
Returns the value of the specified field, or null if the field is undefined.

getHours

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

getMinutes

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

getMonths

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

getSeconds

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

getSign

public abstract int getSign()
Returns the sign of this value.

getTimeInMillis

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.

getTimeInMillis

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.

getXMLSchemaType

public QName getXMLSchemaType()
Returns the name of the XML Schema data type this value maps to.

getYears

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

hashCode

public abstract int hashCode()

isLongerThan

public boolean isLongerThan(Duration duration)

isSet

public abstract boolean isSet(DatatypeConstants.Field field)
Indicates whether the specified field is set.

isShorterThan

public boolean isShorterThan(Duration duration)

multiply

public Duration multiply(int factor)
Returns the result of multiplying this duration by the given factor.

multiply

public abstract Duration multiply(BigDecimal factor)
Returns the result of multiplying this duration by the given factor.

negate

public abstract Duration negate()
Returns the unary negative of this duration.

normalizeWith

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.

subtract

public Duration subtract(Duration rhs)
Returns the result of subtracting the given duration from this duration.

toString

public String toString()
Returns the lexical representation of this duration.