org.exolab.castor.types

Class Date

Implemented Interfaces:
java.io.Serializable
Known Direct Subclasses:
GMonthDay, GYearMonth

public class Date
extends DateTimeBase

Describe an XML schema Date.

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

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

Field Summary

static String
DATE_FORMAT
The Date Format

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

EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, WRONGLY_PLACED

Constructor Summary

Date()
Date(String date)
Constructs a date from a string
Date(java.util.Date dateRef)
This constructor is used to convert a java.util.Date into a new org.exolab.castor.types.Date

Note : all the information concerning the time part of the java.util.Date is lost since a W3C Schema Date only represents CCYY-MM-YY

Date(short[] values)
Constructs a XML Schema Date instance given all the values of the different fields.

Method Summary

short
getHour()
short
getMilli()
short
getMinute()
short
getSeconds()
short[]
getValues()
Returns an array of short with all the fields that describe this Date type.
static Object
parse(String str)
parse a String and convert it into an java.lang.Object
static Date
parseDate(String str)
parse a String and convert it into a Date.
void
setHour(short hour)
void
setMilliSecond(short millisecond)
void
setMinute(short minute)
void
setSecond(short second)
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.

java.util.Date
toDate()
converts this Date into a local java Date.
String
toString()
convert this Date to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM-DD

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

Field Details

DATE_FORMAT

public static final String DATE_FORMAT
The Date Format

Constructor Details

Date

public Date()

Date

public Date(String date)
            throws java.text.ParseException
Constructs a date from a string
Parameters:
date - the string representing the date

Date

public Date(java.util.Date dateRef)
This constructor is used to convert a java.util.Date into a new org.exolab.castor.types.Date

Note : all the information concerning the time part of the java.util.Date is lost since a W3C Schema Date only represents CCYY-MM-YY


Date

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

Method Details

getHour

public short getHour()
Overrides:
getHour in interface DateTimeBase

getMilli

public short getMilli()
Overrides:
getMilli in interface DateTimeBase

getMinute

public short getMinute()
Overrides:
getMinute in interface DateTimeBase

getSeconds

public short getSeconds()
Overrides:
getSeconds in interface DateTimeBase

getValues

public short[] getValues()
Returns an array of short with all the fields that describe this Date 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 Date type.

parse

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

parseDate

public static Date parseDate(String str)
            throws ParseException
parse a String and convert it into a Date.
Parameters:
str - the string to parse
Returns:
the Date represented by the string

setHour

public void setHour(short hour)
Overrides:
setHour in interface DateTimeBase

setMilliSecond

public void setMilliSecond(short millisecond)
Overrides:
setMilliSecond in interface DateTimeBase

setMinute

public void setMinute(short minute)
Overrides:
setMinute in interface DateTimeBase

setSecond

public void setSecond(short second)
Overrides:
setSecond 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 the following:
  • century
  • year
  • month
  • day

toDate

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

toString

public String toString()
convert this Date to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM-DD
Returns:
a string representing this Date

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