org.exolab.castor.types

Class GYearMonth

Implemented Interfaces:
java.io.Serializable
Known Direct Subclasses:
GYear

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

GYearMonth()
public only for the generated source code
GYearMonth(String gyearMonth)
Constructs a GYearMonth given a string representation
GYearMonth(int year, int month)
Instantiates a new gYearMonth given the value of the month and the value of the day.
GYearMonth(short century, short year, short 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.

Method Summary

short
getDay()
short[]
getValues()
Returns an array of short with all the fields that describe this gYearMonth type.
static Object
parse(String str)
parse a String and convert it into an java.lang.Object
static GYearMonth
parseGYearMonth(String str)
parse a String and convert it into a gYearMonth.
void
setDay(short day)
set the Day Field
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 gYearMonth into a local java Date.
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)

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

GYearMonth

public GYearMonth()
public only for the generated source code

GYearMonth

public GYearMonth(String gyearMonth)
            throws ParseException
Constructs a GYearMonth given a string representation
Parameters:
gyearMonth - the string representation of the GYearMonth to instantiate

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

Method Details

getDay

public short getDay()
Overrides:
getDay in interface DateTimeBase

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.

Overrides:
getValues in interface Date
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 Date
Parameters:
str - the string to parse
Returns:
an Object represented by the string

parseGYearMonth

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

setDay

public void setDay(short day)
set the Day Field
Overrides:
setDay in interface DateTimeBase
Parameters:
day - the value to set up Note a validation is done on the day field

setValues

public void setValues(short[] values)
Overrides:
setValues in interface Date
Parameters:
values - an array of shorts with the values the array is supposed to be of length 3 and ordered like the following:
  • century
  • year
  • month

toDate

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

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