net.fortuna.ical4j.model.property

Class Due

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.DateProperty

net.fortuna.ical4j.model.property.Due

All Implemented Interfaces:

java.io.Serializable

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

Property Summary

Properties inherited from class net.fortuna.ical4j.model.Property

isCalendarProperty

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION

Constructor Summary

Constructors

Constructor and Description
Due() Default constructor.
Due(Date aDate) Constructor.
Due(ParameterList aList, Date aDate) Constructor.
Due(ParameterList aList, java.lang.String aValue)
Due(java.lang.String value) Creates a new instance initialised with the parsed value.
Due(java.lang.String value, TimeZone timezone) Creates a new DUE property initialised with the specified timezone and value.
Due(TimeZone timezone) Creates a new DUE property initialised with the specified timezone.

Method Summary

Methods

Modifier and Type	Method and Description
void	validate() Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.property.DateProperty

copy, getDate, getTimeZone, getValue, hashCode, isUtc, setDate, setTimeZone, setUtc, setValue

Methods inherited from class net.fortuna.ical4j.model.Property

equals, getName, getParameter, getParameters, getParameters, isCalendarProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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(java.lang.String value)
    throws java.text.ParseException

Creates a new instance initialised with the parsed value.

Parameters:

value - the DUE value string to parse

Throws:

java.text.ParseException - where the specified string is not a valid DUE value representation

Due

public Due(java.lang.String value,
   TimeZone timezone)
    throws java.text.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:

java.text.ParseException - where the specified value is not a valid string representation

Due

public Due(ParameterList aList,
   java.lang.String aValue)
    throws java.text.ParseException

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Throws:

java.text.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

Method Detail

validate

public final void validate()
                    throws ValidationException

Perform validation on a property.

Overrides:

validate in class DateProperty

Throws:

ValidationException - where the property is not in a valid state