Package net.fortuna.ical4j.model.component

Class VToDo

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Component

net.fortuna.ical4j.model.component.CalendarComponent

net.fortuna.ical4j.model.component.VToDo

All Implemented Interfaces:

Serializable, ChangeManagementPropertyAccessor, ComponentContainer<Component>, ComponentListAccessor<Component>, DateTimePropertyAccessor, DescriptivePropertyAccessor, FluentComponent, PropertyContainer, PropertyListAccessor, RecurrenceSupport<VToDo>, RelationshipPropertyAccessor

public class VToDo
extends CalendarComponent
implements ComponentContainer<Component>, RecurrenceSupport<VToDo>, DescriptivePropertyAccessor, ChangeManagementPropertyAccessor, DateTimePropertyAccessor, RelationshipPropertyAccessor

$Id$ [Apr 5, 2004] Defines an iCalendar VTODO component.

       4.6.2 To-do Component

          Component Name: VTODO

          Purpose: Provide a grouping of calendar properties that describe a
          to-do.

          Formal Definition: A "VTODO" calendar component is defined by the
          following notation:

            todoc      = "BEGIN" ":" "VTODO" CRLF
                         todoprop *alarmc
                         "END" ":" "VTODO" CRLF

            todoprop   = *(

                       ; the following are optional,
                       ; but MUST NOT occur more than once

                       class / completed / created / description / dtstamp /
                       dtstart / geo / last-mod / location / organizer /
                       percent / priority / recurid / seq / status /
                       summary / uid / url /

                       ; either 'due' or 'duration' may appear in
                       ; a 'todoprop', but 'due' and 'duration'
                       ; MUST NOT occur in the same 'todoprop'

                       due / duration /

                       ; the following are optional,
                       ; and MAY occur more than once
                       attach / attendee / categories / comment / contact /
                       exdate / exrule / rstatus / related / resources /
                       rdate / rrule / x-prop

                       )
 

Example 1 - Creating a todo of two (2) hour duration starting tomorrow:

 java.util.Calendar cal = java.util.Calendar.getInstance();
 // tomorrow..
 cal.add(java.util.Calendar.DAY_OF_MONTH, 1);
 cal.set(java.util.Calendar.HOUR_OF_DAY, 11);
 cal.set(java.util.Calendar.MINUTE, 00);

 VToDo documentation = new VEvent(cal.getTime(), 1000 * 60 * 60 * 2,
         "Document calendar component usage");

 // add timezone information..
 VTimeZone tz = VTimeZone.getDefault();
 TzId tzParam = new TzId(tz.getProperties().getProperty(Property.TZID)
         .getValue());
 documentation.getProperties().getProperty(Property.DTSTART).getParameters()
         .add(tzParam);
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VToDo.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.model.component.CalendarComponent

EMPTY_VALIDATOR

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

AVAILABLE, BEGIN, components, END, EXPERIMENTAL_PREFIX, PARTICIPANT, properties, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VLOCATION, VRESOURCE, VTIMEZONE, VTODO, VVENUE

Constructor Summary

Constructors

Constructor	Description
VToDo()	Default constructor.
VToDo(boolean initialise)
VToDo(Temporal start, String summary)	Constructs a new VTODO instance starting at the specified time with the specified summary.
VToDo(Temporal start, TemporalAmount duration, String summary)	Constructs a new VTODO instance starting at the specified times, for the specified duration, with the specified summary.
VToDo(Temporal start, Temporal due, String summary)	Constructs a new VTODO instance starting and ending at the specified times with the specified summary.
VToDo(PropertyList properties)	Constructor.
VToDo(PropertyList properties, ComponentList<VAlarm> alarms)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object arg0)
List<VAlarm>	getAlarms()	Returns the list of alarms for this todo.
ComponentList<Component>	getComponentList()
Optional<Completed>	getDateCompleted()	Deprecated. use DateTimePropertyAccessor.getDateTimeCompleted()
Optional<DtStamp>	getDateStamp()	Deprecated. use ChangeManagementPropertyAccessor.getDateTimeStamp()
<T extends Temporal> Optional<Due<T>>	getDue()	Deprecated. use DateTimePropertyAccessor.getDateTimeDue()
List<VLocation>	getLocations()
List<Participant>	getParticipants()
List<VResource>	getResources()
<T extends Temporal> Optional<DtStart<T>>	getStartDate()	Deprecated. use DateTimePropertyAccessor.getDateTimeStart()
int	hashCode()
protected ComponentFactory<VToDo>	newFactory()	Returns a new component factory used to create deep copies.
void	setComponentList(ComponentList<Component> components)
ValidationResult	validate(boolean recurse)	Perform validation on a component.
ValidationResult	validate(Method method)	Performs method-specific ITIP validation.

Methods inherited from class net.fortuna.ical4j.model.component.CalendarComponent

validateAdd, validateCancel, validateCounter, validateDeclineCounter, validatePublish, validateRefresh, validateReply, validateRequest

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

calculateRecurrenceSet, copy, getFluentTarget, getName, getProperties, getPropertyList, getValue, setPropertyList, toString, validate, validateProperties

Methods inherited from class java.lang.Object

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

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

getCreated, getDateTimeStamp, getLastModified, getSequence

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

add, remove, replace

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

getComponent, getComponents

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

getDateTimeCompleted, getDateTimeDue, getDateTimeEnd, getDateTimeStart, getDuration, getFreeBusyTime, getTimeTransparency

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

addAttachment, getAttachments, getCategories, getClassification, getComments, getDescription, getGeographicPos, getLocation, getPercentComplete, getPriority, getStatus, getSummary, setCategories, setSummary

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

withProperty

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

add, addAll, remove, removeAll, replace, setPropertyList

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

getProperties, getProperty, getPropertyList, getRequiredProperty

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

calculateRecurrenceSet, copy, getOccurrences

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

getAttendees, getContact, getOrganizer, getRecurrenceId, getRelatedTo, getUid, getUrl

Constructor Detail

VToDo

public VToDo()

Default constructor.

VToDo

public VToDo(boolean initialise)

VToDo

public VToDo(PropertyList properties)

Constructor.

Parameters:

properties - a list of properties

VToDo

public VToDo(PropertyList properties,
             ComponentList<VAlarm> alarms)

VToDo

public VToDo(Temporal start,
             String summary)

Constructs a new VTODO instance starting at the specified time with the specified summary.

Parameters:

start - the start date of the new todo

summary - the todo summary

VToDo

public VToDo(Temporal start,
             Temporal due,
             String summary)

Constructs a new VTODO instance starting and ending at the specified times with the specified summary.

Parameters:

start - the start date of the new todo

due - the due date of the new todo

summary - the todo summary

VToDo

public VToDo(Temporal start,
             TemporalAmount duration,
             String summary)

Constructs a new VTODO instance starting at the specified times, for the specified duration, with the specified summary.

Parameters:

start - the start date of the new todo

duration - the duration of the new todo

summary - the todo summary

Method Detail

getAlarms

public final List<VAlarm> getAlarms()

Returns the list of alarms for this todo.

Returns:

a component list

getParticipants

public final List<Participant> getParticipants()

getLocations

public final List<VLocation> getLocations()

getResources

public final List<VResource> getResources()

getComponentList

public ComponentList<Component> getComponentList()

Specified by:

getComponentList in interface ComponentListAccessor<Component>

Returns:

Returns the underlying component list.

setComponentList

public void setComponentList(ComponentList<Component> components)

Specified by:

setComponentList in interface ComponentContainer<Component>

validate

public ValidationResult validate(boolean recurse)
                          throws ValidationException

Perform validation on a component.

Specified by:

validate in class Component

Parameters:

recurse - indicates whether to validate the component's properties

Throws:

ValidationException - where the component is not in a valid state

validate

public ValidationResult validate(Method method)
                          throws ValidationException

Performs method-specific ITIP validation.

Overrides:

validate in class CalendarComponent

Parameters:

method - the applicable method

Throws:

ValidationException - where the component does not comply with RFC2446

getDateCompleted

@Deprecated
public final Optional<Completed> getDateCompleted()

Deprecated.

use DateTimePropertyAccessor.getDateTimeCompleted()

Returns:

the optional date completed property

getStartDate

@Deprecated
public final <T extends Temporal> Optional<DtStart<T>> getStartDate()

Deprecated.

use DateTimePropertyAccessor.getDateTimeStart()

Convenience method to pull the DTSTART out of the property list.

Returns:

The DtStart object representation of the start Date

getDateStamp

@Deprecated
public final Optional<DtStamp> getDateStamp()

Deprecated.

use ChangeManagementPropertyAccessor.getDateTimeStamp()

Returns:

the date-stamp property

getDue

@Deprecated
public final <T extends Temporal> Optional<Due<T>> getDue()

Deprecated.

use DateTimePropertyAccessor.getDateTimeDue()

Returns:

the optional due property

equals

public boolean equals(Object arg0)

Overrides:

equals in class Component

hashCode

public int hashCode()

Overrides:

hashCode in class Component

newFactory

protected ComponentFactory<VToDo> newFactory()

Description copied from class: Component

Returns a new component factory used to create deep copies.

Specified by:

newFactory in class Component

Returns:

a component factory instance