Public Member Functions | Static Public Member Functions

org.exolab.castor.types.GYearMonth Class Reference

Inheritance diagram for org.exolab.castor.types.GYearMonth:
org.exolab.castor.types.Date org.exolab.castor.types.DateTimeBase org.exolab.castor.types.GYear

List of all members.

Public Member Functions

 GYearMonth ()
 GYearMonth (short century, short year, short month)
 GYearMonth (int year, int month)
 GYearMonth (short[] values)
 GYearMonth (String gyearMonth) throws ParseException
void setValues (short[] values)
short[] getValues ()
java.util.Date toDate ()
String toString ()
short getDay ()
void setDay (short day)

Static Public Member Functions

static Object parse (String str) throws ParseException
static GYearMonth parseGYearMonth (String str) throws ParseException

Detailed Description

Describe an XML schema gYearMonth type.

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

Author:
Arnaud Blandin
Version:
Revision:
1.1.1.1

Constructor & Destructor Documentation

org.exolab.castor.types.GYearMonth.GYearMonth (  ) 

public only for the generated source code

Referenced by org.exolab.castor.types.GYearMonth.parseGYearMonth().

org.exolab.castor.types.GYearMonth.GYearMonth ( short  century,
short  year,
short  month 
)

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

Parameters:
century the month value
year the year value
month the month value

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

org.exolab.castor.types.GYearMonth.GYearMonth ( int  year,
int  month 
)

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

Parameters:
year the year value
month the month value

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

org.exolab.castor.types.GYearMonth.GYearMonth ( short[]  values  ) 

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

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

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

org.exolab.castor.types.GYearMonth.GYearMonth ( String  gyearMonth  )  throws ParseException

Constructs a GYearMonth given a string representation

Parameters:
gyearMonth the string representation of the GYearMonth to instantiate

Member Function Documentation

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

Returns an array of short with all the fields that describe this gYearMonth 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.

Reimplemented in org.exolab.castor.types.GYear.

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

static Object org.exolab.castor.types.GYearMonth.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.GYear.

References org.exolab.castor.types.GYearMonth.parseGYearMonth().

static GYearMonth org.exolab.castor.types.GYearMonth.parseGYearMonth ( String  str  )  throws ParseException [static]

parse a String and convert it into a gYearMonth.

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

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

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

void org.exolab.castor.types.GYearMonth.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 3 and ordered like the following:

  • century
  • year
  • month

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

Reimplemented in org.exolab.castor.types.GYear.

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

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


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties