org.exolab.castor.types

Class GYear

java.lang.Object

org.exolab.castor.types.DateTimeBase

org.exolab.castor.types.Date

org.exolab.castor.types.GYearMonth

org.exolab.castor.types.GYear

All Implemented Interfaces:

java.io.Serializable

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: 5951 $

Author:

Arnaud Blandin

See Also:

Serialized Form

Field Summary

Fields inherited from class org.exolab.castor.types.Date

DATE_FORMAT

Fields inherited from class org.exolab.castor.types.DateTimeBase

EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, WRONGLY_PLACED

Constructor Summary

Constructors

Constructor and Description
GYear() public only for the generated source code
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(short century, short year) Instantiates a new gYear given the value of the month and the value of the day.
GYear(java.lang.String gyear) Construct a GYear from a string value

Method Summary

Modifier and Type	Method and Description
short	getMonth()
short[]	getValues() Returns an array of short with all the fields that describe this gYear type.
static java.lang.Object	parse(java.lang.String str) parse a String and convert it into an java.lang.Object
static GYear	parseGYear(java.lang.String str) parse a String and convert it into a gYear.
void	setMonth(short month) set the Month Field
void	setValues(short[] values) Sets all the fields by reading the values in an array
java.util.Date	toDate() converts this gYear into a local java Date.
java.lang.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)

Methods inherited from class org.exolab.castor.types.GYearMonth

getDay, parseGYearMonth, setDay

Methods inherited from class org.exolab.castor.types.Date

getHour, getMilli, getMinute, getSeconds, parseDate, setHour, setMilliSecond, setMinute, setSecond, toLong

Methods inherited from class org.exolab.castor.types.DateTimeBase

addDuration, compareTo, equal, equals, getCentury, getYear, getZoneHour, getZoneMinute, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, setCentury, setNegative, setSecond, setUTC, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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:

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(java.lang.String gyear)
      throws java.text.ParseException

Construct a GYear from a string value

Parameters:

gyear - the string representation of the GYear to instantiate

Throws:

java.text.ParseException

Method Detail

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.

Overrides:

setValues in class GYearMonth

Parameters:

values - an array of shorts with the values the array is supposed to be of length 2 and ordered like the following:

• century
• year

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.

Overrides:

getValues in class GYearMonth

Returns:

an array of short with all the fields that describe this Date type.

toDate

public java.util.Date toDate()

converts this gYear into a local java Date.

Overrides:

toDate in class GYearMonth

Returns:

a local date representing this Date.

toString

public java.lang.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)

Overrides:

toString in class GYearMonth

Returns:

a string representing this Date

parse

public static java.lang.Object parse(java.lang.String str)
                              throws java.text.ParseException

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:

java.text.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(java.lang.String str)
                        throws java.text.ParseException

parse a String and convert it into a gYear.

Parameters:

str - the string to parse

Returns:

the Date represented by the string

Throws:

java.text.ParseException - a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)

getMonth

public short getMonth()

Overrides:

getMonth in class DateTimeBase

setMonth

public void setMonth(short month)

Description copied from class: DateTimeBase

set the Month Field

Overrides:

setMonth in class DateTimeBase

Parameters:

month - the value to set up Note 1