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

  • 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 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(String gyear) throws ParseException
      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 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 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 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 Object
      Returns:
      a string representing this Date

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

      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
      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 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 invalid input: '<'= month invalid input: '<'= 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