org.exolab.castor.types
Class TimeDuration

java.lang.Object
  org.exolab.castor.types.TimeDuration

All Implemented Interfaces:

java.io.Serializable

public class TimeDuration

extends java.lang.Object

implements java.io.Serializable

Represents the timeDuration XML Schema type.

This representation does not support the decimal fraction for the lowest order item. Besides setting TimeDuration to '0' is not possible thus there is no distinction between '0' and 'P0Y'

Version:

$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:02 $

Author:

Arnaud Blandin

See Also:

Serialized Form

Constructor Summary

TimeDuration()
default constructor

TimeDuration(long l)
This constructor fills in the time duration fields according to the value of the long by calling setValue

Method Summary

boolean	equal(TimeDuration timeD) Returns true if the instance of TimeDuration has the same fields of the parameter
boolean	equals(java.lang.Object object) Override the java.lang.equals method
short	getDay()
short	getHour()
short	getMilli()
short	getMinute()
short	getMonth()
short	getSeconds()
short	getYear()
boolean	isGreater(TimeDuration timeD) Returns true if the present instance of TimeDuration is greater than the parameter
boolean	isNegative()
static java.lang.Object	parse(java.lang.String str) parse a String and convert it into a java.lang.Object
static TimeDuration	parseTimeDuration(java.lang.String str) Parse the given string and return a time duration which represents this string
void	setDay(short day)
void	setHour(short hour)
void	setMilli(short milli)
void	setMinute(short minute)
void	setMonth(short month)
void	setNegative()
void	setSeconds(short second)
void	setValue(short year, short month, short day, short hour, short minute, short second, short millisecond) Fill in the fields of the TimeDuration with the given values
void	setYear(short year)
long	toLong() Convert a timeDuration into a long This long represents the duration in milliseconds
java.lang.String	toString() Convert a timeDuration into a String conforming to ISO8601 and XML Schema specs

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeDuration

public TimeDuration()

default constructor

TimeDuration

public TimeDuration(long l)

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

Parameters:

l - the long value of the Time Duration

See Also:

setValue(short, short, short, short, short, short, short)

Method Detail

setYear

public void setYear(short year)

setMonth

public void setMonth(short month)

setDay

public void setDay(short day)

setHour

public void setHour(short hour)

setMinute

public void setMinute(short minute)

setSeconds

public void setSeconds(short second)

setMilli

public void setMilli(short milli)

setNegative

public void setNegative()

setValue

public void setValue(short year,
                     short month,
                     short day,
                     short hour,
                     short minute,
                     short second,
                     short millisecond)

Fill in the fields of the TimeDuration 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

getYear

public short getYear()

getMonth

public short getMonth()

getDay

public short getDay()

getHour

public short getHour()

getMinute

public short getMinute()

getSeconds

public short getSeconds()

getMilli

public short getMilli()

isNegative

public boolean isNegative()

toLong

public long toLong()

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

Returns:

a long representing the duration

toString

public java.lang.String toString()

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

Returns:

a string representing the time duration

parse

public static java.lang.Object parse(java.lang.String str)
                              throws java.text.ParseException

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:

java.text.ParseException - a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)

parseTimeDuration

public static TimeDuration parseTimeDuration(java.lang.String str)
                                      throws java.text.ParseException

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

Returns:

a TimeDuration instance which represent the string

Throws:

java.text.ParseException - thrown when the string is not valid

equals

public boolean equals(java.lang.Object object)

Override the java.lang.equals method

See Also:

equal(org.exolab.castor.types.TimeDuration)

equal

public boolean equal(TimeDuration timeD)

Returns true if the instance of TimeDuration has the same fields of the parameter

Parameters:

timeD - the time duration to compare

Returns:

true if equal, false if not

isGreater

public boolean isGreater(TimeDuration timeD)

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

Note This definition does not follow the XML SCHEMA DRAFT 20001024 the following orger relation is used : t1,t2 timeDuration types t1>t2 iff t1.toLong()>t2.toLong()

Parameters:

timeD - the time duration to compare with the present instance

Returns:

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