org.exolab.castor.types

Class Time

Implemented Interfaces:
java.io.Serializable

public class Time
extends DateTimeBase

Describes an XML schema Time.

The format is defined by W3C XML Schema Recommendation and ISO8601 i.e (-)hh:mm:ss.sss(Z|(+|-)hh:mm)

Currently deep support of milli seconds is not implemented. This implementation only support up to 3 figures for milli-seconds.

Version:
$Revision: 1.1.1.1 $
Author:
Arnaud Blandin
See Also:
DateTimeBase, Serialized Form

Field Summary

Fields inherited from class org.exolab.castor.types.DateTimeBase

EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, WRONGLY_PLACED

Constructor Summary

Time()
Time(String time)
Constructs a Time given a string representation.
Time(long l)
Constructs a XML Schema Time instance given a long representing the time in milliseconds.
Time(short[] values)
Constructs a XML Schema Time instance given all the values of the different fields.

Method Summary

short
getCentury()
short
getDay()
void
getDay(short day)
short
getMonth()
void
getMonth(short month)
short[]
getValues()
returns an array of short with all the fields that describe this time type.
short
getYear()
void
getYear(short year)
static Object
parse(String str)
parses a String and converts it into a java.lang.Object
static Time
parseTime(String str)
parses a String and converts it into a Time.
void
setCentury(short century)
void
setValues(short[] values)
Sets all the fields by reading the values in an array.
Date
toDate()
converts this Time into a local java Date.
String
toString()
convert this Time to a string The format is defined by W3C XML Schema Recommendation and ISO8601 i.e (-)hh:mm:ss.sss(Z|(+|-)hh:mm)

Methods inherited from class org.exolab.castor.types.DateTimeBase

addDuration, compareTo, equal, equals, getCentury, getDay, getHour, getMilli, getMinute, getMonth, getSeconds, getValues, getYear, getZoneHour, getZoneMinute, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, setCentury, setDay, setHour, setMilliSecond, setMinute, setMonth, setNegative, setSecond, setSecond, setUTC, setValues, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar, toDate

Constructor Details

Time

public Time()

Time

public Time(String time)
            throws ParseException
Constructs a Time given a string representation.
Parameters:
time - the string representation of the Time to instantiate

Time

public Time(long l)
Constructs a XML Schema Time instance given a long representing the time in milliseconds. By default a Time is not UTC and is local.
Parameters:

Time

public Time(short[] values)
Constructs a XML Schema Time instance given all the values of the different fields. By default a Time is not UTC and is local.
Parameters:
values - an array of shorts that represent the different fields of Time.

Method Details

getCentury

public short getCentury()
Overrides:
getCentury in interface DateTimeBase

getDay

public short getDay()
Overrides:
getDay in interface DateTimeBase

getDay

public void getDay(short day)

getMonth

public short getMonth()
Overrides:
getMonth in interface DateTimeBase

getMonth

public void getMonth(short month)

getValues

public short[] getValues()
returns an array of short with all the fields that describe this time type.

Note:the time zone is not included.

Overrides:
getValues in interface DateTimeBase
Returns:
an array of short with all the fields that describe this time type.

getYear

public short getYear()
Overrides:
getYear in interface DateTimeBase

getYear

public void getYear(short year)

parse

public static Object parse(String str)
            throws ParseException
parses a String and converts it into a java.lang.Object
Parameters:
str - the string to parse
Returns:
the java.lang.Object represented by the string

parseTime

public static Time parseTime(String str)
            throws ParseException
parses a String and converts it into a Time.
Parameters:
str - the string to parse
Returns:
the Time represented by the string

setCentury

public void setCentury(short century)
Overrides:
setCentury in interface DateTimeBase

setValues

public void setValues(short[] values)
Overrides:
setValues in interface DateTimeBase
Parameters:
values - an array of shorts with the values the array is supposed to be of length 4 and ordered like that:
  • hour
  • minute
  • second
  • millisecond

toDate

public Date toDate()
converts this Time into a local java Date.
Overrides:
toDate in interface DateTimeBase
Returns:
a local date representing this Time

toString

public String toString()
convert this Time to a string The format is defined by W3C XML Schema Recommendation and ISO8601 i.e (-)hh:mm:ss.sss(Z|(+|-)hh:mm)
Returns:
a string representing this Time

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