ACS-10.0 Java API: org.exolab.castor.types.GMonth Class Reference

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

List of all members.

Public Member Functions
	GMonth ()
	GMonth (short month)
	GMonth (int month)
	GMonth (String gmonth) throws ParseException
java.util.Date	toDate ()
String	toString ()
short	getDay ()
void	setDay (short day)
Static Public Member Functions
static Object	parse (String str) throws ParseException
static GMonth	parseGMonth (String str) throws ParseException

Detailed Description

Describe an XML schema gMonth type.

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

Author:: Arnaud Blandin

Version:

Revision:: 1.1.1.1

Constructor & Destructor Documentation

org.exolab.castor.types.GMonth.GMonth ( )

public only for the generated source code

Referenced by org.exolab.castor.types.GMonth.parseGMonth().

org.exolab.castor.types.GMonth.GMonth ( short month )

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

Parameters:

month

the month value.

References org.exolab.castor.types.DateTimeBase.setMonth().

org.exolab.castor.types.GMonth.GMonth ( int month )

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

Parameters:

month

the month value.

References org.exolab.castor.types.DateTimeBase.setMonth().

org.exolab.castor.types.GMonth.GMonth ( String gmonth ) throws ParseException

Constructs a GMonth from a string value.

Parameters:

gmonth

the string representation of the GMonth to instantiate

Member Function Documentation

short org.exolab.castor.types.GMonth.getDay ( )

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

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

References org.exolab.castor.types.GMonth.parseGMonth().

static GMonth org.exolab.castor.types.GMonth.parseGMonth ( String str ) throws ParseException [static]

parse a String and convert it into a GMonth.

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.GMonth.GMonth().

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

void org.exolab.castor.types.GMonth.setDay ( short day )

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.DateTimeBase.

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

converts this GMonth into a local java Date.

Returns:: a local date representing this Date.

Reimplemented from org.exolab.castor.types.GMonthDay.

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.GMonth.toString().

String org.exolab.castor.types.GMonth.toString ( )

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

Returns:: a string representing this Date

Reimplemented from org.exolab.castor.types.GMonthDay.

References 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.GMonth.toDate(), and org.exolab.castor.builder.types.XSGMonth.validationCode().

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

GMonth.java

All Classes Namespaces Files Functions Variables Enumerations Properties