org.exolab.castor.types

Class Time

java.lang.Object

org.exolab.castor.types.DateTimeBase

org.exolab.castor.types.Time

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

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

Constructors

Constructor and Description
Time()
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.
Time(java.lang.String time) Constructs a Time given a string representation.

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object	parse(java.lang.String str) parses a String and converts it into a java.lang.Object
static Time	parseTime(java.lang.String str) parses a String and converts it into a Time.
void	setCentury(short century) set the century field
void	setValues(short[] values) Sets all the fields by reading the values in an array.
java.util.Date	toDate() converts this Time into a local java Date.
java.lang.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, getHour, getMilli, getMinute, getSeconds, getZoneHour, getZoneMinute, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, setDay, setHour, setMilliSecond, setMinute, setMonth, setNegative, setSecond, setSecond, setUTC, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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(java.lang.String time)
     throws java.text.ParseException

Constructs a Time given a string representation.

Parameters:

time - the string representation of the Time to instantiate

Throws:

java.text.ParseException

Method Detail

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.

Specified by:

setValues in class 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

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.

Specified by:

getValues in class DateTimeBase

Returns:

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

toDate

public java.util.Date toDate()

converts this Time into a local java Date.

Specified by:

toDate in class DateTimeBase

Returns:

a local date representing this Time

toString

public java.lang.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)

Overrides:

toString in class java.lang.Object

Returns:

a string representing this Time

parse

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

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)

parseTime

public static Time parseTime(java.lang.String str)
                      throws java.text.ParseException

parses a String and converts it into a Time.

Parameters:

str - the string to parse

Returns:

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

getCentury

public short getCentury()

Overrides:

getCentury in class DateTimeBase

getYear

public short getYear()

Overrides:

getYear in class DateTimeBase

getMonth

public short getMonth()

Overrides:

getMonth in class DateTimeBase

getDay

public short getDay()

Overrides:

getDay in class DateTimeBase

setCentury

public void setCentury(short century)

Description copied from class: DateTimeBase

set the century field

Overrides:

setCentury in class DateTimeBase

Parameters:

century - the value to set up

getYear

public void getYear(short year)

getMonth

public void getMonth(short month)

getDay

public void getDay(short day)