org.exolab.castor.types

Class TimeDuration

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

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

boolean
isNegative()
static Object
parse(String str)
parse a String and convert it into a java.lang.Object
static TimeDuration
parseTimeDuration(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
String
toString()
Convert a timeDuration into a String conforming to ISO8601 and XML Schema specs

Constructor Details

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

Method Details

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

equals

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

getDay

public short getDay()

getHour

public short getHour()

getMilli

public short getMilli()

getMinute

public short getMinute()

getMonth

public short getMonth()

getSeconds

public short getSeconds()

getYear

public short getYear()

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

isNegative

public boolean isNegative()

parse

public static Object parse(String str)
            throws 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

parseTimeDuration

public static TimeDuration parseTimeDuration(String str)
            throws ParseException
Parse the given string and return a time duration which represents this string
Parameters:
Returns:
a TimeDuration instance which represent the string

setDay

public void setDay(short day)

setHour

public void setHour(short hour)

setMilli

public void setMilli(short 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,
                     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

setYear

public void setYear(short year)

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 String toString()
Returns:
a string representing the time duration

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