javax.xml.datatype

Class Duration


public abstract class Duration
extends java.lang.Object

An immutable time space as specified in XML Schema 1.0.

Since:
1.3

Method Summary

Duration
add(Duration rhs)
Returns the result of adding the specified duration to this duration.
void
addTo(Calendar calendar)
Adds this duration to the specified calendar.
void
addTo(Date date)
Adds this duration to the specified date.
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.
boolean
equals(java.lang.Object duration)
int
getDays()
Returns the days in this duration as an int, or 0 if not present.
Number
getField(DatatypeConstants.Field field)
Returns the value of the specified field, or null if the field is undefined.
int
getHours()
Returns the hours in this duration as an int, or 0 if not present.
int
getMinutes()
Returns the minutes in this duration as an int, or 0 if not present.
int
getMonths()
Returns the months in this duration as an int, or 0 if not present.
int
getSeconds()
Returns the seconds in this duration as an int, or 0 if not present.
int
getSign()
Returns the sign of this value.
long
getTimeInMillis(Calendar startInstant)
Returns the duration length in milliseconds.
long
getTimeInMillis(Date startInstant)
Returns the duration length in milliseconds.
QName
getXMLSchemaType()
Returns the name of the XML Schema data type this value maps to.
int
getYears()
Returns the years in this duration as an int, or 0 if not present.
int
hashCode()
boolean
isLongerThan(Duration duration)
boolean
isSet(DatatypeConstants.Field field)
Indicates whether the specified field is set.
boolean
isShorterThan(Duration duration)
Duration
multiply(BigDecimal factor)
Returns the result of multiplying this duration by the given factor.
Duration
multiply(int factor)
Returns the result of multiplying this duration by the given factor.
Duration
negate()
Returns the unary negative of this duration.
Duration
normalizeWith(Calendar startTimeInstant)
Converts the years and months fields into the days field using a specific time instant as the reference point.
Duration
subtract(Duration rhs)
Returns the result of subtracting the given duration from this duration.
String
toString()
Returns the lexical representation of this duration.

Method Details

add

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


addTo

public 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 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(java.lang.Object duration)


getDays

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


getField

public 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 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 int hashCode()


isLongerThan

public boolean isLongerThan(Duration duration)


isSet

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


isShorterThan

public boolean isShorterThan(Duration duration)


multiply

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


multiply

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


negate

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


normalizeWith

public 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.