GYear (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.types.DateTimeBase
- - org.exolab.castor.types.GYear

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
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 $

Author:

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

Constructors
Constructor	Description
`GYear()`	public only for the generated source code
`GYear(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.
`GYear(java.lang.String gyear)`	Construct a GYear from a string value

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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 java.lang.Object`	`parse(java.lang.String str)`	parse a String and convert it into an java.lang.Object
`static GYear`	`parseGYear(java.lang.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 array
`java.util.Date`	`toDate()`	converts this gYear into a local java Date.
`java.lang.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, 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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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 value
    
    year - 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
```
public GYear(java.lang.String gyear)
      throws java.text.ParseException
```
    Construct a GYear from a string value
    
    Parameters:
    
    gyear - the string representation of the GYear to instantiate
    
    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)
- 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.
    Specified by:
    
    setValues in class 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
  - 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 class DateTimeBase
    
    Returns:
    
    an array of short with all the fields that describe this Date type.
  - toDate
```
public java.util.Date toDate()
```
    converts this gYear into a local java Date.
    
    Specified by:
    
    toDate in class DateTimeBase
    
    Returns:
    
    a local date representing this Date.
  - toString
```
public java.lang.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 class java.lang.Object
    
    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)
  - parseGYear
```
public static GYear parseGYear(java.lang.String str)
                        throws java.text.ParseException
```
    parse a String and convert it into a gYear.
    
    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)
  - hasMonth
```
public boolean hasMonth()
```
    Overrides:
    
    hasMonth in class DateTimeBase
  - getMonth
```
public short getMonth()
```
    Overrides:
    
    getMonth in class DateTimeBase
  - setMonth
```
public void setMonth(short year)
```
    Description copied from class: DateTimeBase
    
    Sets the Month Field. Note 1 <= month <= 12.
    
    Overrides:
    
    setMonth in class DateTimeBase
    
    Parameters:
    
    year - the value to set up
  - hasDay
```
public boolean hasDay()
```
    Overrides:
    
    hasDay in class DateTimeBase
  - getDay
```
public short getDay()
```
    Overrides:
    
    getDay in class DateTimeBase
  - 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 class DateTimeBase
    
    Parameters:
    
    month - the value to set up
  - hasHour
```
public boolean hasHour()
```
    Overrides:
    
    hasHour in class DateTimeBase
  - getHour
```
public short getHour()
```
    Overrides:
    
    getHour in class DateTimeBase
  - setHour
```
public void setHour(short hour)
```
    Description copied from class: DateTimeBase
    
    Sets the hour field for this date/time type.
    
    Overrides:
    
    setHour in class DateTimeBase
    
    Parameters:
    
    hour - the hour to set
  - hasMinute
```
public boolean hasMinute()
```
    Overrides:
    
    hasMinute in class DateTimeBase
  - getMinute
```
public short getMinute()
```
    Overrides:
    
    getMinute in class DateTimeBase
  - setMinute
```
public void setMinute(short minute)
```
    Description copied from class: DateTimeBase
    
    set the minute field for this date/time type.
    
    Overrides:
    
    setMinute in class DateTimeBase
    
    Parameters:
    
    minute - the minute to set.
  - hasSeconds
```
public boolean hasSeconds()
```
    Overrides:
    
    hasSeconds in class DateTimeBase
  - getSeconds
```
public short getSeconds()
```
    Overrides:
    
    getSeconds in class DateTimeBase
  - 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 class DateTimeBase
    
    Parameters:
    
    second - the second to set
  - hasMilli
```
public boolean hasMilli()
```
    Overrides:
    
    hasMilli in class DateTimeBase
  - getMilli
```
public short getMilli()
```
    Overrides:
    
    getMilli in class DateTimeBase
  - setMilliSecond
```
public void setMilliSecond(short millisecond)
```
    Description copied from class: DateTimeBase
    
    Sets the millisecond field for this date/time type.
    
    Overrides:
    
    setMilliSecond in class DateTimeBase
    
    Parameters:
    
    millisecond - the millisecond to set

Class GYear

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GYear

GYear

GYear

GYear

GYear

Method Detail

setValues

getValues

toDate

toString

parse

parseGYear

hasMonth

getMonth

setMonth

hasDay

getDay

setDay

hasHour

getHour

setHour

hasMinute

getMinute

setMinute

hasSeconds

getSeconds

setSecond

hasMilli

getMilli

setMilliSecond