org.exolab.castor.types

Class GYear

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

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

Method Summary

short
getMonth()
short[]
getValues()
Returns an array of short with all the fields that describe this gYear type.
static Object
parse(String str)
parse a String and convert it into an java.lang.Object
static GYear
parseGYear(String str)
parse a String and convert it into a gYear.
void
setMonth(short month)
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.

java.util.Date
toDate()
converts this gYear into a local java Date.
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, getValues, parse, parseGYearMonth, setDay, setValues, toDate, toString

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

getHour, getMilli, getMinute, getSeconds, getValues, parse, parseDate, setHour, setMilliSecond, setMinute, setSecond, setValues, toDate, toString

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

addDuration, compareTo, equal, equals, getCentury, getDay, getHour, getMilli, getMinute, getMonth, getSeconds, getValues, getYear, getZoneHour, getZoneMinute, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, setCentury, setDay, setHour, setMilliSecond, setMinute, setMonth, setNegative, setSecond, setSecond, setUTC, setValues, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar, toDate

Constructor Details

GYear

public GYear()
public only for the generated source code

GYear

public GYear(String gyear)
            throws ParseException
Construct a GYear from a string value
Parameters:
gyear - the string representation of the GYear to instantiate

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

Method Details

getMonth

public short getMonth()
Overrides:
getMonth in interface DateTimeBase

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 interface GYearMonth
Returns:
an array of short with all the fields that describe this Date type.

parse

public static Object parse(String str)
            throws ParseException
parse a String and convert it into an java.lang.Object
Overrides:
parse in interface GYearMonth
Parameters:
str - the string to parse
Returns:
an Object represented by the string

parseGYear

public static GYear parseGYear(String str)
            throws ParseException
parse a String and convert it into a gYear.
Parameters:
str - the string to parse
Returns:
the Date represented by the string

setMonth

public void setMonth(short month)
Overrides:
setMonth in interface DateTimeBase

setValues

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

toDate

public java.util.Date toDate()
converts this gYear into a local java Date.
Overrides:
toDate in interface GYearMonth
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)
Overrides:
toString in interface GYearMonth
Returns:
a string representing this Date

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