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 Duration
add(Duration rhs)
Returns the result of adding the specified duration to this duration.
abstract void
addTo(Calendar calendar)
Adds this duration to the specified calendar.
void
addTo(Date date)
Adds this duration to the specified date.
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.
boolean
equals(Object duration)
Determine whether this Object is semantically equal to another Object.
int
getDays()
Returns the days in this duration as an int, or 0 if not present.
abstract 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.
abstract 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.
abstract int
hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean
isLongerThan(Duration duration)
abstract boolean
isSet(DatatypeConstants.Field field)
Indicates whether the specified field is set.
boolean
isShorterThan(Duration duration)
Duration
multiply(int factor)
Returns the result of multiplying this duration by the given factor.
abstract Duration
multiply(BigDecimal factor)
Returns the result of multiplying this duration by the given factor.
abstract Duration
negate()
Returns the unary negative of this duration.
abstract 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.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

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

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()
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

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.
Overrides:
toString in interface Object

Duration.java -- Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.