org.exolab.castor.types

Class Time

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: 5951 $

Author: Arnaud Blandin

See Also: DateTimeBase

Constructor Summary
Time()
Time(short[] values)
Constructs a XML Schema Time instance given all the values of the different fields.
Time(long l)
Constructs a XML Schema Time instance given a long representing the time in milliseconds.
Time(String time)
Constructs a Time given a string representation.
Method Summary
shortgetCentury()
shortgetDay()
voidgetDay(short day)
shortgetMonth()
voidgetMonth(short month)
short[]getValues()
returns an array of short with all the fields that describe this time type.
shortgetYear()
voidgetYear(short year)
static Objectparse(String str)
parses a String and converts it into a java.lang.Object
static TimeparseTime(String str)
parses a String and converts it into a Time.
voidsetCentury(short century)
voidsetValues(short[] values)
Sets all the fields by reading the values in an array.
DatetoDate()
converts this Time into a local java Date.
StringtoString()
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)

Constructor Detail

Time

public Time()

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.

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: l The long value that represents the time instance.

Time

public Time(String time)
Constructs a Time given a string representation.

Parameters: time the string representation of the Time to instantiate

Method Detail

getCentury

public short getCentury()

getDay

public short getDay()

getDay

public void getDay(short day)

getMonth

public short getMonth()

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.

Returns: an array of short with all the fields that describe this time type.

getYear

public short getYear()

getYear

public void getYear(short year)

parse

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

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

parseTime

public static Time parseTime(String str)
parses a String and converts it into a Time.

Parameters: str the string to parse

Returns: the Time 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)

setCentury

public void setCentury(short century)

setValues

public void setValues(short[] values)
Sets all the fields by reading the values in an array.

if a Time Zone is specificied it has to be set by using setZone.

Parameters: values an array of shorts with the values the array is supposed to be of length 4 and ordered like that:

toDate

public Date toDate()
converts this Time into a local java Date.

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-2006. All rights reserved http://www.intalio.com