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

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

List of all members.

Public Member Functions
	GDay ()
	GDay (short day)
	GDay (int day)
	GDay (String gday) throws ParseException
java.util.Date	toDate ()
String	toString ()
short	getMonth ()
void	setMonth (short month)
Static Public Member Functions
static Object	parse (String str) throws ParseException
static GDay	parseGDay (String str) throws ParseException

Detailed Description

Describe an XML schema gDay type.

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

Author:: Arnaud Blandin

Version:

Revision:: 1.1.1.1

Constructor & Destructor Documentation

org.exolab.castor.types.GDay.GDay ( )

public only for the generated source code

Referenced by org.exolab.castor.types.GDay.parseGDay().

org.exolab.castor.types.GDay.GDay ( short day )

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

Parameters:

values

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

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

org.exolab.castor.types.GDay.GDay ( int day )

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

Parameters:

values

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

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

org.exolab.castor.types.GDay.GDay ( String gday ) throws ParseException

Constructs a GDay from a string value.

Parameters:

gday

the string representation of the GDay to instantiate

Member Function Documentation

short org.exolab.castor.types.GDay.getMonth ( )

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

static Object org.exolab.castor.types.GDay.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.GDay.parseGDay().

static GDay org.exolab.castor.types.GDay.parseGDay ( String str ) throws ParseException [static]

parse a String and convert it into a GDay.

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

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

void org.exolab.castor.types.GDay.setMonth ( short month )

set the Month Field

Parameters:

month

the value to set up Note 1<month<12

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

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

converts this GDay 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.GDay.toString().

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

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

Returns:: a string representing this Date

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

References org.exolab.castor.types.DateTimeBase.getDay(), 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.GDay.toDate(), and org.exolab.castor.builder.types.XSGDay.validationCode().

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

GDay.java

All Classes Namespaces Files Functions Variables Enumerations Properties