Class Due

  • All Implemented Interfaces:
    Serializable, Comparable<Property>

    public class Due
    extends DateProperty
    $Id$

    Created: [Apr 6, 2004]

    Defines a DUE iCalendar component property.

         4.8.2.3 Date/Time Due
    
            Property Name: DUE
    
            Purpose: This property defines the date and time that a to-do is
            expected to be completed.
    
            Value Type: The default value type is DATE-TIME. The value type can
            be set to a DATE value type.
    
            Property Parameters: Non-standard, value data type, time zone
            identifier property parameters can be specified on this property.
    
            Conformance: The property can be specified once in a "VTODO" calendar
            component.
    
            Description: The value MUST be a date/time equal to or after the
            DTSTART value, if specified.
    
            Format Definition: The property is defined by the following notation:
    
              due        = "DUE" dueparam":" dueval CRLF
    
              dueparam   = *(
                         ; the following are optional,
                         ; but MUST NOT occur more than once
    
                         (";" "VALUE" "=" ("DATE-TIME" / "DATE")) /
                         (";" tzidparam) /
    
                         ; the following is optional,
                         ; and MAY occur more than once
    
                           *(";" xparam)
    
                         )
    
    
    
              dueval     = date-time / date
              ;Value MUST match value type
     
    See Also:
    Serialized Form
    • Constructor Detail

      • Due

        public Due()
        Default constructor. The time value is initialised to the time of instantiation.
      • Due

        public Due​(TimeZone timezone)
        Creates a new DUE property initialised with the specified timezone.
        Parameters:
        timezone - initial timezone
      • Due

        public Due​(String value)
            throws ParseException
        Creates a new instance initialised with the parsed value.
        Parameters:
        value - the DUE value string to parse
        Throws:
        ParseException - where the specified string is not a valid DUE value representation
      • Due

        public Due​(String value,
                   TimeZone timezone)
            throws ParseException
        Creates a new DUE property initialised with the specified timezone and value.
        Parameters:
        value - a string representation of a DUE value
        timezone - initial timezone
        Throws:
        ParseException - where the specified value is not a valid string representation
      • Due

        public Due​(ParameterList aList,
                   String aValue)
            throws ParseException
        Parameters:
        aList - a list of parameters for this component
        aValue - a value string for this component
        Throws:
        ParseException - when the specified string is not a valid date/date-time representation
      • Due

        public Due​(Date aDate)
        Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
        Parameters:
        aDate - a date
      • Due

        public Due​(ParameterList aList,
                   Date aDate)
        Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
        Parameters:
        aList - a list of parameters for this component
        aDate - a date