org.exolab.castor.types

Class GMonthDay

java.lang.Object

org.exolab.castor.types.DateTimeBase

org.exolab.castor.types.Date

org.exolab.castor.types.GMonthDay

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GDay, GMonth

public class GMonthDay
extends Date

Describe an XML schema gMonthDay type.

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

Version:

$Revision: 5951 $

Author:

Arnaud Blandin

See Also:

Serialized Form

Field Summary

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

DATE_FORMAT

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

EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, WRONGLY_PLACED

Constructor Summary

Constructors

Constructor and Description
GMonthDay() public only for the generated source code
GMonthDay(int month, int day) Instantiates a new gMonthDay given the value of the month and the value of the day.
GMonthDay(short[] values) Constructs a XML Schema GMonthDay instance given all the values of the different fields.
GMonthDay(short month, short day) Instantiates a new gMonthDay given the value of the month and the value of the day.
GMonthDay(java.lang.String gmonthDay) Construct a GMonthDay from a string value

Method Summary

Modifier and Type	Method and Description
short	getCentury()
short[]	getValues() Returns an array of short with all the fields that describe this gMonthDay type.
short	getYear()
static java.lang.Object	parse(java.lang.String str) parse a String and convert it into an java.lang.Object
static GMonthDay	parseGMonthDay(java.lang.String str) parse a String and convert it into a gMonthDay.
void	setCentury(short century) set the century field
void	setNegative() set the negative field to true
void	setValues(short[] values) Sets all the fields by reading the values in an array
void	setYear(short year) set the Year field Note: 0000 is not allowed
java.util.Date	toDate() converts this gMonthDay into a local java Date.
java.lang.String	toString() convert this gMonthDay to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e --MM-DD(Z|(+|-)hh:mm)

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

getHour, getMilli, getMinute, getSeconds, parseDate, setHour, setMilliSecond, setMinute, setSecond, toLong

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

addDuration, compareTo, equal, equals, getDay, getMonth, getZoneHour, getZoneMinute, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, setDay, setMonth, setSecond, setUTC, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar

Methods inherited from class java.lang.Object

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

Constructor Detail

GMonthDay

public GMonthDay()

public only for the generated source code

GMonthDay

public GMonthDay(short month,
                 short day)

Instantiates a new gMonthDay given the value of the month and the value of the day.

Parameters:

month - the month value

day - the day value

GMonthDay

public GMonthDay(int month,
                 int day)

Instantiates a new gMonthDay given the value of the month and the value of the day.

Parameters:

month - the month value

day - the day value

GMonthDay

public GMonthDay(short[] values)

Constructs a XML Schema GMonthDay instance given all the values of the different fields. By default a GMonthDay is not UTC and is local.

Parameters:

values - an array of shorts that represent the different fields of Time.

GMonthDay

public GMonthDay(java.lang.String gmonthDay)
          throws java.text.ParseException

Construct a GMonthDay from a string value

Parameters:

gmonthDay - the string representation of the GMonthDay 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.

Overrides:

setValues in class Date

Parameters:

values - an array of shorts with the values the array is supposed to be of length 2 and ordered like the following:

• Month
• Day

getValues

public short[] getValues()

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

Note:the time zone is not included.

Overrides:

getValues in class Date

Returns:

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

toDate

public java.util.Date toDate()

converts this gMonthDay into a local java Date.

Overrides:

toDate in class Date

Returns:

a local date representing this Date.

toString

public java.lang.String toString()

convert this gMonthDay to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e --MM-DD(Z|(+|-)hh:mm)

Overrides:

toString in class Date

Returns:

a string representing this Date

parse

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

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)

parseGMonthDay

public static GMonthDay parseGMonthDay(java.lang.String str)
                                throws java.text.ParseException

parse a String and convert it into a gMonthDay.

Parameters:

str - the string to parse

Returns:

the Date 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

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

Overrides:

getYear in class DateTimeBase

setYear

public void setYear(short year)

Description copied from class: DateTimeBase

set the Year field Note: 0000 is not allowed

Overrides:

setYear in class DateTimeBase

Parameters:

year - year to set up

setNegative

public void setNegative()

Description copied from class: DateTimeBase

set the negative field to true

Overrides:

setNegative in class DateTimeBase