org.exolab.castor.types

Class GYear

public class GYear extends GYearMonth

Describe an XML schema gYear type.

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

Version: $Revision: 1.1.1.1 $

Author: Arnaud Blandin

Constructor Summary
GYear()
public only for the generated source code
GYear(short century, short year)
Instantiates a new gYear given the value of the month and the value of the day.
GYear(int year)
Instantiates a new gYear given the value of the month and the value of the day.
GYear(short[] values)
Constructs a XML Schema GYear instance given all the values of the different fields.
GYear(String gyear)
Construct a GYear from a string value
Method Summary
shortgetMonth()
short[]getValues()
Returns an array of short with all the fields that describe this gYear type.
static Objectparse(String str)
parse a String and convert it into an java.lang.Object
static GYearparseGYear(String str)
parse a String and convert it into a gYear.
voidsetMonth(short month)
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 gYear into a local java Date.
StringtoString()
convert this gYear to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM(Z|(+|-)hh:mm)

Constructor Detail

GYear

public GYear()
public only for the generated source code

GYear

public GYear(short century, short year)
Instantiates a new gYear given the value of the month and the value of the day.

Parameters: century the month value year the year value

GYear

public GYear(int year)
Instantiates a new gYear given the value of the month and the value of the day.

Parameters: century the month value year the year value

GYear

public GYear(short[] values)
Constructs a XML Schema GYear instance given all the values of the different fields. By default a GYear is not UTC and is local.

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

GYear

public GYear(String gyear)
Construct a GYear from a string value

Parameters: gyear the string representation of the GYear to instantiate

Method Detail

getMonth

public short getMonth()

getValues

public short[] getValues()
Returns an array of short with all the fields that describe this gYear 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)

parseGYear

public static GYear parseGYear(String str)
parse a String and convert it into a gYear.

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)

setMonth

public void setMonth(short month)

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 2 and ordered like the following:

toDate

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

Returns: a local date representing this Date.

toString

public String toString()
convert this gYear 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-2003. All rights reserved http://www.intalio.com