org.exolab.castor.types

Class Duration

public class Duration extends Object implements Serializable

This class is the representation of XML Schema datatype: duration.

This representation does not support the decimal fraction for the lowest order item.

The order relation provided by this implementation does not follow the guidelines of XML Schema Specification that defines only a partial order.

For more information see X3C XML Schema Specification.

Version: $Revision: 5951 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author: Arnaud Blandin

Constructor Summary
Duration()
default constructor
Duration(String duration)
Constructs a duration from a string
Duration(long l)

This constructor fills in the duration fields according to the value of the long by calling setValue.

Method Summary
booleanequal(Duration duration)
Returns true if the instance of TimeDuration has the same fields of the parameter
booleanequals(Object object)
Override the java.lang.equals method
shortgetDay()
shortgetHour()
longgetMilli()
shortgetMinute()
shortgetMonth()
shortgetSeconds()
shortgetYear()
inthashCode()
Overrides the java.lang.Object#hashcode method.
booleanisGreater(Duration duration)

Returns true if the present instance of TimeDuration is greater than the parameter

Note This definition does not follow the XML SCHEMA RECOMMENDATION 05022001 the following total order relation is used : givent t1,t2 timeDuration types t1>t2 iff t1.toLong()>t2.toLong()

booleanisNegative()
static Objectparse(String str)
parse a String and convert it into a java.lang.Object
static DurationparseDuration(String str)

Parse the given string and return a time duration which represents this string.

voidsetDay(short day)
voidsetHour(short hour)
voidsetMilli(long milli)
voidsetMinute(short minute)
voidsetMonth(short month)
voidsetNegative()
voidsetSeconds(short second)
voidsetValue(short year, short month, short day, short hour, short minute, short second, long millisecond)
Fill in the fields of the duration with the given values
voidsetYear(short year)
longtoLong()

Convert a duration into a long This long represents the duration in milliseconds.

StringtoString()

Convert a duration into a String conforming to ISO8601 and XML Schema specs

Constructor Detail

Duration

public Duration()
default constructor

Duration

public Duration(String duration)
Constructs a duration from a string

Parameters: duration the string representation of the duration to create

Duration

public Duration(long l)

This constructor fills in the duration fields according to the value of the long by calling setValue.

Parameters: l the long value of the Duration

See Also: Duration

Method Detail

equal

public boolean equal(Duration duration)
Returns true if the instance of TimeDuration has the same fields of the parameter

Parameters: duration the time duration to compare

Returns: true if equal, false if not

equals

public boolean equals(Object object)
Override the java.lang.equals method

See Also: Duration

getDay

public short getDay()

getHour

public short getHour()

getMilli

public long getMilli()

getMinute

public short getMinute()

getMonth

public short getMonth()

getSeconds

public short getSeconds()

getYear

public short getYear()

hashCode

public int hashCode()
Overrides the java.lang.Object#hashcode method.

isGreater

public boolean isGreater(Duration duration)

Returns true if the present instance of TimeDuration is greater than the parameter

Note This definition does not follow the XML SCHEMA RECOMMENDATION 05022001 the following total order relation is used : givent t1,t2 timeDuration types t1>t2 iff t1.toLong()>t2.toLong()

Parameters: duration the time duration to compare with the present instance

Returns: true if the present instance is the greatest, false if not

isNegative

public boolean isNegative()

parse

public static Object parse(String str)
parse a String and convert it into a java.lang.Object

Parameters: str the string to parse

Returns: the java.lang.Object represented by the string

Throws: ParseException a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)

parseDuration

public static Duration parseDuration(String str)

Parse the given string and return a time duration which represents this string.

Parameters: str the string to parse

Returns: a TimeDuration instance which represent the string

Throws: ParseException thrown when the string is not valid

setDay

public void setDay(short day)

setHour

public void setHour(short hour)

setMilli

public void setMilli(long milli)

setMinute

public void setMinute(short minute)

setMonth

public void setMonth(short month)

setNegative

public void setNegative()

setSeconds

public void setSeconds(short second)

setValue

public void setValue(short year, short month, short day, short hour, short minute, short second, long millisecond)
Fill in the fields of the duration with the given values

Parameters: year the year value month the month value day the day value hour the hour value minute the minute value second the second value

setYear

public void setYear(short year)

toLong

public long toLong()

Convert a duration into a long This long represents the duration in milliseconds.

Returns: a long representing the duration

toString

public String toString()

Convert a duration into a String conforming to ISO8601 and XML Schema specs

Returns: a string representing the duration

Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com