org.exolab.castor.types

Class GYear

Implemented Interfaces:
Cloneable, java.io.Serializable

public class GYear
extends DateTimeBase

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: 7289 $
Authors:
Arnaud Blandin
Edward Kuns
See Also:
Serialized Form

Field Summary

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

EQUALS, GREATER_THAN, INDETERMINATE, LESS_THAN, MAX_TIME_ZONE_COMPARISON_OFFSET, 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 year.
GYear(short century, short year)
Instantiates a new gYear given the value of the century and year.
GYear(short[] values)
Constructs a XML Schema GYear instance given all the values of the different fields.

Method Summary

short
getDay()
short
getHour()
short
getMilli()
short
getMinute()
short
getMonth()
short
getSeconds()
short[]
getValues()
Returns an array of short with all the fields that describe this gYear type.
boolean
hasDay()
boolean
hasHour()
boolean
hasMilli()
boolean
hasMinute()
boolean
hasMonth()
boolean
hasSeconds()
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
setDay(short month)
void
setHour(short hour)
void
setMilliSecond(short millisecond)
void
setMinute(short minute)
void
setMonth(short year)
void
setSecond(short second)
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.DateTimeBase

addDuration, appendDateString, appendTimeString, appendTimeZoneString, clone, compareTo, equal, equals, getCentury, getDay, getHour, getMilli, getMinute, getMonth, getSeconds, getValues, getYear, getZoneHour, getZoneMinute, hasCentury, hasDay, hasHour, hasIsNegative, hasMilli, hasMinute, hasMonth, hasSeconds, hasYear, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setCentury, setDateFormatTimeZone, setDateFormatTimeZone, 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 year. Here, the year is the normal representation of a year, that is, a four-digit value.
Parameters:
year - the year value

GYear

public GYear(short century,
             short year)
Instantiates a new gYear given the value of the century and year.
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

getDay

public short getDay()
Overrides:
getDay in interface DateTimeBase

getHour

public short getHour()
Overrides:
getHour in interface DateTimeBase

getMilli

public short getMilli()
Overrides:
getMilli in interface DateTimeBase

getMinute

public short getMinute()
Overrides:
getMinute in interface DateTimeBase

getMonth

public short getMonth()
Overrides:
getMonth in interface DateTimeBase

getSeconds

public short getSeconds()
Overrides:
getSeconds 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 DateTimeBase
Returns:
an array of short with all the fields that describe this Date type.

hasDay

public boolean hasDay()
Overrides:
hasDay in interface DateTimeBase

hasHour

public boolean hasHour()
Overrides:
hasHour in interface DateTimeBase

hasMilli

public boolean hasMilli()
Overrides:
hasMilli in interface DateTimeBase

hasMinute

public boolean hasMinute()
Overrides:
hasMinute in interface DateTimeBase

hasMonth

public boolean hasMonth()
Overrides:
hasMonth in interface DateTimeBase

hasSeconds

public boolean hasSeconds()
Overrides:
hasSeconds in interface DateTimeBase

parse

public static Object parse(String str)
            throws 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

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

setDay

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

setHour

public void setHour(short hour)
Overrides:
setHour in interface DateTimeBase

setMilliSecond

public void setMilliSecond(short millisecond)
Overrides:
setMilliSecond in interface DateTimeBase

setMinute

public void setMinute(short minute)
Overrides:
setMinute in interface DateTimeBase

setMonth

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

setSecond

public void setSecond(short second)
Overrides:
setSecond in interface DateTimeBase

setValues

public void setValues(short[] values)
Overrides:
setValues in interface DateTimeBase
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 DateTimeBase
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-2008. All rights reserved http://www.intalio.com