org.exolab.castor.types

Class GYearMonth

public class GYearMonth extends Date

Describe an XML schema gYearMonth type.

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

Version: $Revision: 5951 $

Author: Arnaud Blandin

Constructor Summary
GYearMonth()
public only for the generated source code
GYearMonth(short century, short year, short month)
Instantiates a new gYearMonth given the value of the month and the value of the day.
GYearMonth(int year, int month)
Instantiates a new gYearMonth given the value of the month and the value of the day.
GYearMonth(short[] values)
Constructs a XML Schema GYearMonth instance given all the values of the different fields.
GYearMonth(String gyearMonth)
Constructs a GYearMonth given a string representation
Method Summary
shortgetDay()
short[]getValues()
Returns an array of short with all the fields that describe this gYearMonth type.
static Objectparse(String str)
parse a String and convert it into an java.lang.Object
static GYearMonthparseGYearMonth(String str)
parse a String and convert it into a gYearMonth.
voidsetDay(short day)
voidsetValues(short[] values)
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.

DatetoDate()
converts this gYearMonth into a local java Date.
StringtoString()
convert this gYearMonth to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM(Z|(+|-)hh:mm)

Constructor Detail

GYearMonth

public GYearMonth()
public only for the generated source code

GYearMonth

public 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

GYearMonth

public 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

GYearMonth

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

GYearMonth

public GYearMonth(String gyearMonth)
Constructs a GYearMonth given a string representation

Parameters: gyearMonth the string representation of the GYearMonth to instantiate

Method Detail

getDay

public short getDay()

getValues

public short[] getValues()
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.

parse

public static Object parse(String str)
parse a String and convert it into an java.lang.Object

Parameters: str the string to parse

Returns: an Object represented by the string

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

parseGYearMonth

public static GYearMonth parseGYearMonth(String str)
parse a String and convert it into a gYearMonth.

Parameters: str the string to parse

Returns: the Date represented by the string

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

setDay

public void setDay(short day)

setValues

public void setValues(short[] values)
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:

toDate

public Date toDate()
converts this gYearMonth into a local java Date.

Returns: a local date representing this Date.

toString

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

Returns: a string representing this Date

Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com