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

Public Member Functions
	Month ()
void	setDay (short day) throws OperationNotSupportedException
void	setHour (short hour) throws OperationNotSupportedException
void	setMinute (short minute) throws OperationNotSupportedException
void	setSecond (short second, short millsecond) throws OperationNotSupportedException
void	setZone (short hour, short minute) throws OperationNotSupportedException
void	setZoneNegative () throws OperationNotSupportedException
String	toString ()
java.util.Date	toDate () throws ParseException
Static Public Member Functions
static Object	parse (String str) throws ParseException
static Month	parseMonth (String str) throws ParseException

Detailed Description

Describe an XML schema Month.

The date type is derived from time period by setting up the facet :

duration to "P1M"

Author:: Arnaud Blandin

Version:

Revision:: 1.1.1.1

Constructor & Destructor Documentation

org.exolab.castor.types.Month.Month ( )

Referenced by org.exolab.castor.types.Month.parseMonth().

Member Function Documentation

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

Reimplemented from org.exolab.castor.types.RecurringDuration.

References org.exolab.castor.types.Month.parseMonth().

static Month org.exolab.castor.types.Month.parseMonth ( String str ) throws ParseException [static]

parse a String and convert it into a Month

Parameters:

str

the string to parse

Returns:: the Month 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.RecurringDurationBase.isNegative(), org.exolab.castor.types.Month.Month(), org.exolab.castor.types.RecurringDuration.setCentury(), org.exolab.castor.types.RecurringDuration.setMonth(), org.exolab.castor.types.RecurringDurationBase.setNegative(), and org.exolab.castor.types.RecurringDuration.setYear().

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

void org.exolab.castor.types.Month.setDay ( short day ) throws OperationNotSupportedException

set the Day Field

Parameters:

day

the value to set up Note a validation is done on the day field

Reimplemented from org.exolab.castor.types.RecurringDuration.

void org.exolab.castor.types.Month.setHour ( short hour ) throws OperationNotSupportedException

set the hour field for this recurringDuration

Parameters:

hour

the hour to set

Exceptions:

OperationNotSupportedException

this exception is thrown when changing the value of the hour field is not allowed

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

void org.exolab.castor.types.Month.setMinute ( short minute ) throws OperationNotSupportedException

set the minute field for this recurringDuration

Parameters:

minute

the minute to set

Exceptions:

OperationNotSupportedException

this exception is thrown when changing the value of the minute field is not allowed

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

void org.exolab.castor.types.Month.setSecond	(	short	second,
		short	millsecond
	)			throws OperationNotSupportedException

set the second field for this recurringDuration

Parameters:

	second	the second to set
	millsecond	the millisecond to set

Exceptions:

OperationNotSupportedException

this exception is thrown when changing the value of the second field is not allowed

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

void org.exolab.castor.types.Month.setZone	(	short	hour,
		short	minute
	)			throws OperationNotSupportedException

set the time zone fields for this recurringDuration

Parameters:

	hour	the time zone hour to set
	minute	the time zone minute to set

Exceptions:

OperationNotSupportedException

this exception is thrown when changing the value of the time zone fields is not allowed

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

void org.exolab.castor.types.Month.setZoneNegative ( ) throws OperationNotSupportedException

set the time zone negative field to true

Exceptions:

OperationNotSupportedException

this exception is thrown when changing the time zone fields is not allowed

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

java.util.Date org.exolab.castor.types.Month.toDate ( ) throws ParseException

convert this recurringDuration into a local Date

Note : Be aware a the 'local' property of the date i.e toDate() will de the conversion between a UTC date and your computer date format. For instance if you have set up your computer time zone on the Pacific Day Time the conversion of 2000-10-20T00:00:00.000 into a java.util.Date will return Thu Oct 19 17:00:00 PDT 2000