Package org.exolab.castor.types
Class GYear
java.lang.Object
org.exolab.castor.types.DateTimeBase
org.exolab.castor.types.GYear
- All Implemented Interfaces:
Serializable
,Cloneable
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 $
- Author:
- Arnaud Blandin, Edward Kuns
- See Also:
-
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
ConstructorsConstructorDescriptionGYear()
public only for the generated source codeGYear
(int year) Instantiates a new gYear given the value of the year.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 century and year.Construct a GYear from a string value -
Method Summary
Modifier and TypeMethodDescriptionshort
getDay()
short
getHour()
short
getMilli()
short
short
getMonth()
short
short[]
Returns an array of short with all the fields that describe this gYear type.boolean
hasDay()
boolean
hasHour()
boolean
hasMilli()
boolean
boolean
hasMonth()
boolean
static Object
parse a String and convert it into an java.lang.Objectstatic GYear
parseGYear
(String str) parse a String and convert it into a gYear.void
setDay
(short month) Sets the Day Field.void
setHour
(short hour) Sets the hour field for this date/time type.void
setMilliSecond
(short millisecond) Sets the millisecond field for this date/time type.void
setMinute
(short minute) set the minute field for this date/time type.void
setMonth
(short year) Sets the Month Field.void
setSecond
(short second) Sets the seconds field for this date/time type, not including the fractional seconds.void
setValues
(short[] values) Sets all the fields by reading the values in an arraytoDate()
converts this gYear into a local java Date.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, getYear, getZoneHour, getZoneMinute, hasCentury, hashCode, hasIsNegative, hasYear, isLeap, isNegative, isUTC, isZoneNegative, normalize, parseDay, parseMonth, parseTime, parseTimeZone, parseYear, setCentury, setDateFormatTimeZone, setDateFormatTimeZone, setNegative, setSecond, setUTC, setYear, setZone, setZoneHour, setZoneMinute, setZoneNegative, toCalendar
-
Constructor Details
-
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 century and year.- Parameters:
century
- the month valueyear
- the year value
-
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[] 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
Construct a GYear from a string value- Parameters:
gyear
- the string representation of the GYear to instantiate- Throws:
ParseException
- a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)
-
-
Method Details
-
setValues
public void setValues(short[] values) Sets all the fields by reading the values in an arrayif a Time Zone is specificied it has to be set by using
setZone
.- Specified by:
setValues
in classDateTimeBase
- 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.
- Specified by:
getValues
in classDateTimeBase
- Returns:
- an array of short with all the fields that describe this Date type.
-
toDate
converts this gYear into a local java Date.- Specified by:
toDate
in classDateTimeBase
- Returns:
- a local date representing this Date.
-
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) -
parse
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:
ParseException
- a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)
-
parseGYear
parse a String and convert it into a gYear.- Parameters:
str
- the string to parse- Returns:
- the Date represented by the string
- Throws:
ParseException
- a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)
-
hasMonth
public boolean hasMonth()- Overrides:
hasMonth
in classDateTimeBase
-
getMonth
public short getMonth()- Overrides:
getMonth
in classDateTimeBase
-
setMonth
public void setMonth(short year) Description copied from class:DateTimeBase
Sets the Month Field. Note 1 invalid input: '<'= month invalid input: '<'= 12.- Overrides:
setMonth
in classDateTimeBase
- Parameters:
year
- the value to set up
-
hasDay
public boolean hasDay()- Overrides:
hasDay
in classDateTimeBase
-
getDay
public short getDay()- Overrides:
getDay
in classDateTimeBase
-
setDay
public void setDay(short month) Description copied from class:DateTimeBase
Sets the Day Field. Note: This field is validated before the assignment is done.- Overrides:
setDay
in classDateTimeBase
- Parameters:
month
- the value to set up
-
hasHour
public boolean hasHour()- Overrides:
hasHour
in classDateTimeBase
-
getHour
public short getHour()- Overrides:
getHour
in classDateTimeBase
-
setHour
public void setHour(short hour) Description copied from class:DateTimeBase
Sets the hour field for this date/time type.- Overrides:
setHour
in classDateTimeBase
- Parameters:
hour
- the hour to set
-
hasMinute
public boolean hasMinute()- Overrides:
hasMinute
in classDateTimeBase
-
getMinute
public short getMinute()- Overrides:
getMinute
in classDateTimeBase
-
setMinute
public void setMinute(short minute) Description copied from class:DateTimeBase
set the minute field for this date/time type.- Overrides:
setMinute
in classDateTimeBase
- Parameters:
minute
- the minute to set.
-
hasSeconds
public boolean hasSeconds()- Overrides:
hasSeconds
in classDateTimeBase
-
getSeconds
public short getSeconds()- Overrides:
getSeconds
in classDateTimeBase
-
setSecond
public void setSecond(short second) Description copied from class:DateTimeBase
Sets the seconds field for this date/time type, not including the fractional seconds. Any fractional seconds previously set is unmodified.- Overrides:
setSecond
in classDateTimeBase
- Parameters:
second
- the second to set
-
hasMilli
public boolean hasMilli()- Overrides:
hasMilli
in classDateTimeBase
-
getMilli
public short getMilli()- Overrides:
getMilli
in classDateTimeBase
-
setMilliSecond
public void setMilliSecond(short millisecond) Description copied from class:DateTimeBase
Sets the millisecond field for this date/time type.- Overrides:
setMilliSecond
in classDateTimeBase
- Parameters:
millisecond
- the millisecond to set
-