Inheritance diagram for org.exolab.castor.types.GMonthDay:

Public Member Functions
	GMonthDay ()
	GMonthDay (short month, short day)
	GMonthDay (int month, int day)
	GMonthDay (short[] values)
	GMonthDay (String gmonthDay) throws ParseException
void	setValues (short[] values)
short[]	getValues ()
java.util.Date	toDate ()
String	toString ()
short	getCentury ()
void	setCentury (short century)
short	getYear ()
void	setYear (short year)
void	setNegative ()
Static Public Member Functions
static Object	parse (String str) throws ParseException
static GMonthDay	parseGMonthDay (String str) throws ParseException

Detailed Description

Describe an XML schema gMonthDay type.

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

Author:: Arnaud Blandin

Version:

Revision:: 1.1.1.1

Constructor & Destructor Documentation

org.exolab.castor.types.GMonthDay.GMonthDay ( )

public only for the generated source code

Referenced by org.exolab.castor.types.GMonthDay.parseGMonthDay().

org.exolab.castor.types.GMonthDay.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

References org.exolab.castor.types.DateTimeBase.setDay(), and org.exolab.castor.types.DateTimeBase.setMonth().

org.exolab.castor.types.GMonthDay.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

References org.exolab.castor.types.DateTimeBase.setDay(), and org.exolab.castor.types.DateTimeBase.setMonth().

org.exolab.castor.types.GMonthDay.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.

References org.exolab.castor.types.GMonthDay.setValues().

org.exolab.castor.types.GMonthDay.GMonthDay ( String gmonthDay ) throws ParseException

Construct a GMonthDay from a string value

Parameters:

gmonthDay

the string representation of the GMonthDay to instantiate

Member Function Documentation

short org.exolab.castor.types.GMonthDay.getCentury ( )

Reimplemented from org.exolab.castor.types.DateTimeBase.

Referenced by org.exolab.castor.types.GMonthDay.getValues().

short [] org.exolab.castor.types.GMonthDay.getValues ( ) [virtual]

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

Note:the time zone is not included.

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

Reimplemented from org.exolab.castor.types.Date.

References org.exolab.castor.types.GMonthDay.getCentury(), and org.exolab.castor.types.GMonthDay.getYear().

short org.exolab.castor.types.GMonthDay.getYear ( )

Reimplemented from org.exolab.castor.types.DateTimeBase.

Referenced by org.exolab.castor.types.GMonthDay.getValues().

static Object org.exolab.castor.types.GMonthDay.parse ( String str ) throws ParseException [static]

parse a String and convert it into an java.lang.Object

Parameters:

str

the string to parse

Returns:: an Object represented by the string

Exceptions:

ParseException

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

Reimplemented from org.exolab.castor.types.Date.

Reimplemented in org.exolab.castor.types.GDay, and org.exolab.castor.types.GMonth.

References org.exolab.castor.types.GMonthDay.parseGMonthDay().

static GMonthDay org.exolab.castor.types.GMonthDay.parseGMonthDay ( String str ) throws ParseException [static]

parse a String and convert it into a gMonthDay.

Parameters:

str

the string to parse

Returns:: the Date represented by the string

Exceptions:

ParseException

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

References org.exolab.castor.types.GMonthDay.GMonthDay().

Referenced by org.exolab.castor.types.GMonthDay.parse().

void org.exolab.castor.types.GMonthDay.setCentury ( short century )

set the century field

Parameters:

century

the value to set up

Reimplemented from org.exolab.castor.types.DateTimeBase.

void org.exolab.castor.types.GMonthDay.setNegative ( )

set the negative field to true

Reimplemented from org.exolab.castor.types.DateTimeBase.

void org.exolab.castor.types.GMonthDay.setValues ( short[] values ) [virtual]

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 2 and ordered like the following:

Month
Day

Reimplemented from org.exolab.castor.types.Date.

References org.exolab.castor.types.DateTimeBase.setDay(), and org.exolab.castor.types.DateTimeBase.setMonth().

Referenced by org.exolab.castor.types.GMonthDay.GMonthDay().

void org.exolab.castor.types.GMonthDay.setYear ( short year )

set the Year field Note: 0000 is not allowed

Parameters:

the

year to set up

Reimplemented from org.exolab.castor.types.DateTimeBase.

java.util.Date org.exolab.castor.types.GMonthDay.toDate ( ) [virtual]

converts this gMonthDay into a local java Date.

Returns:: a local date representing this Date.

Reimplemented from org.exolab.castor.types.Date.

Reimplemented in org.exolab.castor.types.GDay, and org.exolab.castor.types.GMonth.

References org.exolab.castor.types.Date.Date(), org.exolab.castor.types.DateTimeBase.getZoneHour(), org.exolab.castor.types.DateTimeBase.getZoneMinute(), org.exolab.castor.types.DateTimeBase.isUTC(), org.exolab.castor.types.DateTimeBase.isZoneNegative(), and org.exolab.castor.types.GMonthDay.toString().

String org.exolab.castor.types.GMonthDay.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)

Returns:: a string representing this Date

Reimplemented from org.exolab.castor.types.Date.

Reimplemented in org.exolab.castor.types.GDay, and org.exolab.castor.types.GMonth.

References org.exolab.castor.types.DateTimeBase.getDay(), org.exolab.castor.types.DateTimeBase.getMonth(), org.exolab.castor.types.DateTimeBase.getZoneHour(), org.exolab.castor.types.DateTimeBase.getZoneMinute(), org.exolab.castor.types.DateTimeBase.isUTC(), and org.exolab.castor.types.DateTimeBase.isZoneNegative().

Referenced by org.exolab.castor.types.GMonthDay.toDate(), and org.exolab.castor.builder.types.XSGMonthDay.validationCode().

The documentation for this class was generated from the following file:

GMonthDay.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.types.GMonthDay Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation