Class Date

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class Date
    extends DateTimeBase
    Describe an XML Schema Date.

    The format is defined by W3C XML Schema Recommendation and ISO8601 i.e (-)CCYY-MM-DD(Z|(+|-)hh:mm)

    Version:
    $Revision: 7289 $
    Author:
    Arnaud Blandin, Edward Kuns
    See Also:
    Serialized Form
    • Constructor Detail

      • Date

        public Date()
        No-arg constructor.
      • Date

        public Date​(short[] values)
        Constructs a XML Schema Date instance given all the values of the different fields. By default a Date is not UTC and is local.
        Parameters:
        values - an array of shorts that represent the different fields of Time.
      • Date

        public Date​(long dateAsLong)
        This constructor is used to convert a long value representing a Date to a new org.exolab.castor.types.Date instance.

        Note : all the information concerning the time part of the java.util.Date is lost since a W3C Schema Date only represents CCYY-MM-YY

        Parameters:
        dateAsLong - Date represented in from of a long value.
      • Date

        public Date​(java.util.Date dateRef)
        This constructor is used to convert a java.util.Date into a new org.exolab.castor.types.Date.

        Note : all the information concerning the time part of the java.util.Date is lost since a W3C Schema Date only represents CCYY-MM-YY.

        Parameters:
        dateRef - the java.util.Date to use to construct a new org.exolab.castor.types.Date
      • Date

        public Date​(java.lang.String date)
             throws java.text.ParseException
        Constructs a date from a string.
        Parameters:
        date - the string representing the date
        Throws:
        java.text.ParseException - a parse exception is thrown if the string to parse does not follow the right 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 specified, 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 4 and ordered like the following:
        • century
        • year
        • month
        • day
      • getValues

        public short[] getValues()
        Returns an array of short with all the fields that describe this Date 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 Date into a local java.util.Date.
        Specified by:
        toDate in class DateTimeBase
        Returns:
        a local date representing this Date.
      • toLong

        public long toLong()
        Converts this date into a long value.
        Returns:
        This date instance as a long value.
      • toString

        public java.lang.String toString()
        convert this Date to a string The format is defined by W3C XML Schema recommendation and ISO8601 i.e (+|-)CCYY-MM-DD
        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 right format (see the description of this class)
      • parseDate

        public static Date parseDate​(java.lang.String str)
                              throws java.text.ParseException
        parse a String and convert it into a Date.
        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 right format (see the description of this class)
      • 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
      • 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.
      • 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
      • 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