Module ical4j.core

Package net.fortuna.ical4j.model.property

Class Due<T extends Temporal>

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.DateProperty<T>

net.fortuna.ical4j.model.property.Due<T>

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty, Prototype<Property>

public class Due<T extends Temporal>
extends DateProperty<T>

$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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Due.Factory<T extends Temporal>

Field Summary

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

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, 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, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
Due(String value)	Creates a new instance initialised with the parsed value.
Due(ParameterList aList, String aValue)
Due(ParameterList aList, T aDate)	Constructor.
Due(T aDate)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected PropertyFactory<Due<T>>	newFactory()	Returns a new property factory used to create deep copies.

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

compareTo, getDate, getValue, hashCode, isUtc, refreshParameters, setDate, setDefaultTimeZone, setTimeZoneRegistry, setValue, validate

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

add, copy, equals, getFluentTarget, getName, getParameter, getParameter, getParameterList, getParameters, getPrefix, getRequiredParameter, getRequiredParameter, remove, removeAll, replace, setParameters, setPrefix, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Details

Due

public Due(String value)

Creates a new instance initialised with the parsed value.

Parameters:

value - the DUE value string to parse

Throws:

DateTimeParseException - where the specified string is not a valid DUE value representation

Due

public Due(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Throws:

DateTimeParseException - when the specified string is not a valid date/date-time representation

Due

public Due(T 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,
 T 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 Details

newFactory

protected PropertyFactory<Due<T>> newFactory()

Description copied from class: Property

Returns a new property factory used to create deep copies.

Specified by:

newFactory in class Property

Returns:

a property factory instance