org.exolab.castor.types
Class GYearMonth

java.lang.Object
  extended byorg.exolab.castor.types.DateTimeBase
      extended byorg.exolab.castor.types.Date
          extended byorg.exolab.castor.types.GYearMonth
All Implemented Interfaces:
java.io.Serializable
Direct Known 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
 
Constructor Summary
GYearMonth()
          public only for the generated source code
GYearMonth(int year, int 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.
GYearMonth(short century, short year, short month)
          Instantiates a new gYearMonth given the value of the month and the value of the day.
GYearMonth(java.lang.String gyearMonth)
          Constructs a GYearMonth given a string representation
 
Method Summary
 short getDay()
           
 short[] getValues()
          Returns an array of short with all the fields that describe this gYearMonth type.
static java.lang.Object parse(java.lang.String str)
          parse a String and convert it into an java.lang.Object
static GYearMonth parseGYearMonth(java.lang.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
 java.util.Date toDate()
          converts this gYearMonth into a local java Date.
 java.lang.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, parseDate, setHour, setMilliSecond, setMinute, setSecond
 
Methods inherited from class org.exolab.castor.types.DateTimeBase
addDuration, compareTo, equals, getCentury, getMonth, getYear, getZoneHour, getZoneMinute, hashCode, isLeap, isNegative, isUTC, isZoneNegative, normalize, setCentury, setMonth, setNegative, setSecond, setUTC, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GYearMonth

public GYearMonth()
public only for the generated source code


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

GYearMonth

public GYearMonth(java.lang.String gyearMonth)
           throws java.text.ParseException
Constructs a GYearMonth given a string representation

Parameters:
gyearMonth - the string representation of the GYearMonth to instantiate
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 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

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

toDate

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

Overrides:
toDate in class Date
Returns:
a local date representing this Date.

toString

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

parseGYearMonth

public static GYearMonth parseGYearMonth(java.lang.String str)
                                  throws java.text.ParseException
parse a String and convert it into a gYearMonth.

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)

getDay

public short getDay()
Overrides:
getDay in class DateTimeBase

setDay

public void setDay(short day)
Description copied from class: DateTimeBase
set the Day Field

Overrides:
setDay in class DateTimeBase
Parameters:
day - the value to set up Note a validation is done on the day field


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