Class RecurringDuration

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    TimeInstant, TimePeriod

    public class RecurringDuration
    extends RecurringDurationBase
    Deprecated.
    since Castor 1.0.6 since this type is not in any recommendation.
    Represents recurringDuration utterly a recurringDuration must contain all the fields:

    (+|-)CCYY-MM-DDThh:mm:ss.sss(Z|(+|-)hh:mm)

    The validation of the date fields is done in the set methods and follows the ISO8601 Date and Time Format

    It is possible to omit higher components by using '-'.

    Note: This datatype is not included in any recommendation. It was introduced in http://www.w3.org/TR/1999/WD-xmlschema-2-19990924/ and was last in http://www.w3.org/TR/2000/CR-xmlschema-2-20001024/ and was removed by http://www.w3.org/TR/2001/PR-xmlschema-2-20010316/. It was not in the final approved recommendation: http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/

    Version:
    $Revision: 7294 $
    Author:
    Arnaud Blandin
    See Also:
    Serialized Form
    • Constructor Detail

      • RecurringDuration

        public RecurringDuration()
        Deprecated.
      • RecurringDuration

        public RecurringDuration​(TimeDuration duration,
                                 TimeDuration period)
        Deprecated.
        returns a recurringDuration with the facets duration and period set up
        Parameters:
        duration - the TimeDuration representing the duration facet
        period - the TimeDuration reprensenting the period facet
      • RecurringDuration

        public RecurringDuration​(java.lang.String duration,
                                 java.lang.String period)
        Deprecated.
        returns a recurringDuration with the facets duration and period set up
        Parameters:
        duration - the String representing the duration facet
        period - the String reprensenting the period facet
      • RecurringDuration

        public RecurringDuration​(java.lang.String duration,
                                 java.lang.String period,
                                 short[] values)
                          throws java.lang.UnsupportedOperationException
        Deprecated.
        returns a recurringDuration with the facets duration and period set up but also the fields
        Parameters:
        duration - the String representing the duration facet
        period - the String reprensenting the period facet
        values - an array of shorts which contains the values of the fields
        Throws:
        java.lang.UnsupportedOperationException
        See Also:
        setValues(short[])
    • Method Detail

      • setCentury

        public void setCentury​(short century)
        Deprecated.
        set the century field
        Parameters:
        century - the value to set up
      • setYear

        public void setYear​(short year)
                     throws java.lang.UnsupportedOperationException
        Deprecated.
        set the Year field Note: 0000 is not allowed
        Parameters:
        year - year to set up
        Throws:
        java.lang.UnsupportedOperationException
      • setMonth

        public void setMonth​(short month)
                      throws java.lang.UnsupportedOperationException
        Deprecated.
        set the Month Field
        Parameters:
        month - the value to set up Note 1
        Throws:
        java.lang.UnsupportedOperationException
      • setDay

        public void setDay​(short day)
                    throws java.lang.UnsupportedOperationException
        Deprecated.
        set the Day Field
        Parameters:
        day - the value to set up Note a validation is done on the day field
        Throws:
        java.lang.UnsupportedOperationException
      • isLeap

        public boolean isLeap()
        Deprecated.
        return true if the year field represents a leap year A specific year is a leap year if it is either evenly divisible by 400 OR evenly divisible by 4 and not evenly divisible by 100
        Returns:
        true if the year field represents a leap year
      • setValues

        public void setValues​(short[] values)
                       throws java.lang.UnsupportedOperationException
        Deprecated.
        set all the fields by reading the values in an array
        Overrides:
        setValues in class RecurringDurationBase
        Parameters:
        values - an array of shorts with the values the array is supposed to be of length 10 and ordered like that:
        • century
        • year
        • month
        • day
        • hour
        • minute
        • second
        • millisecond
        • zoneHour
        • zoneMinute
        Throws:
        java.lang.UnsupportedOperationException - this exception is thrown if changing the value of one field os not allowed
        See Also:
        RecurringDurationBase.setValues(short[])
      • getCentury

        public short getCentury()
        Deprecated.
      • getYear

        public short getYear()
        Deprecated.
      • getMonth

        public short getMonth()
        Deprecated.
      • getDay

        public short getDay()
        Deprecated.
      • getValues

        public short[] getValues()
        Deprecated.
        returns an array of short with all the fields which describe a RecurringDuration
        Overrides:
        getValues in class RecurringDurationBase
        Returns:
        an array of short with all the fields which describe a RecurringDuration
      • toDate

        public java.util.Date toDate()
                              throws java.text.ParseException
        Deprecated.
        convert this recurringDuration into a local Date

        Note : Be aware a the 'local' property of the date i.e toDate() will de the conversion between a UTC date and your computer date format. For instance if you have set up your computer time zone on the Pacific Day Time the conversion of 2000-10-20T00:00:00.000 into a java.util.Date will return Thu Oct 19 17:00:00 PDT 2000

        Returns:
        a local date representing this recurringDuration
        Throws:
        java.text.ParseException
      • toString

        public java.lang.String toString()
        Deprecated.

        Convert this recurringDuration to a string

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

        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representing this recurringDuration
      • parse

        public static java.lang.Object parse​(java.lang.String str)
                                      throws java.text.ParseException
        Deprecated.
        Throws:
        java.text.ParseException
      • parseRecurringDuration

        public static RecurringDuration parseRecurringDuration​(java.lang.String str)
                                                        throws java.text.ParseException
        Deprecated.
        Parse a String and convert it into a recurringDuration.
        Parameters:
        str - The string to parse.
        Returns:
        The recurringDuration 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).
      • equal

        public boolean equal​(RecurringDuration reccD)
                      throws ValidationException
        Deprecated.

        Returns true if the present instance of Recurring Duration is equal to the parameter.

        The equals relation is the following :

        rd1 equals rd2 iff each field of rd1 is equal to the corresponding field of rd2

        Parameters:
        reccD - the recurring duration to compare with the present instance
        Returns:
        true if the present instance is equal to the parameter false if not
        Throws:
        ValidationException
      • isGreater

        public boolean isGreater​(RecurringDuration reccD)
                          throws ValidationException
        Deprecated.

        Returns true if the present instance of RecurringDuration is greater than the parameter

        Note : the order relation follows the W3C XML Schema draft i.e rd1 < rd2 iff rd2-rd1>0

        Parameters:
        reccD - the recurring duration to compare with the present instance
        Returns:
        true if the present instance is the greatest, false if not
        Throws:
        ValidationException