jfxtras.labs.icalendar.components

Class VTodo<I,T>

java.lang.Object

jfxtras.labs.icalendar.components.VComponentBase<I,T>

jfxtras.labs.icalendar.components.VTodo<I,T>

All Implemented Interfaces:

VComponent<I>

public class VTodo<I,T>
extends VComponentBase<I,T>

Property Summary

Properties inherited from class jfxtras.labs.icalendar.components.VComponentBase

categoriesProperty, commentProperty, dateTimeCreatedProperty, dateTimeLastModifiedProperty, dateTimeRecurrenceProperty, dateTimeStampProperty, dateTimeStartProperty, exDateProperty, organizerProperty, rDateProperty, relatedToProperty, rRuleProperty, sequenceProperty, summaryProperty, uniqueIdentifierProperty

Nested Class Summary

Nested classes/interfaces inherited from interface jfxtras.labs.icalendar.components.VComponent

VComponent.StartEndRange

Field Summary

Fields inherited from interface jfxtras.labs.icalendar.components.VComponent

VCOMPONENT_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
VTodo()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<I>	instances() The currently generated instances of the recurrence set.
boolean	isValid() Checks to see if VComponent is has all required properties filled.
java.util.Collection<I>	makeInstances() Returns the collection of recurrence instances of calendar component of type T that exists between dateTimeRangeStart and dateTimeRangeEnd based on VComponent.
java.util.Collection<I>	makeInstances(java.time.temporal.Temporal start, java.time.temporal.Temporal end) Returns the collection of recurrence instances of calendar component of type T that exists between dateTimeRangeStart and dateTimeRangeEnd based on VComponent.
java.util.stream.Stream<java.time.temporal.Temporal>	streamLimitedByRange() Produces a stream of start dates or date/times by calling VComponent.stream(Temporal) using VComponent.getStartRange() as the temporal parameter, minus the duration if the VComponent has one.
java.lang.String	toComponentText() returns string of line-separated properties defining calendar component.

Methods inherited from class jfxtras.labs.icalendar.components.VComponentBase

becomingIndividual, categoriesProperty, changedStartAndEndDateTime, commentProperty, copyTo, dateTimeCreatedProperty, dateTimeLastModifiedProperty, dateTimeRecurrenceProperty, dateTimeStampProperty, dateTimeStartProperty, editOne, editThisAndFuture, exDateProperty, getCategories, getComment, getDateTimeCreated, getDateTimeLastModified, getDateTimeRecurrence, getDateTimeStamp, getDateTimeStart, getEndRange, getExDate, getOrganizer, getParent, getRDate, getRelatedTo, getRRule, getSequence, getStartRange, getSummary, getUidGeneratorCallback, getUniqueIdentifier, handleDelete, handleEdit, isExDatesOnOneLine, isGoogleRecurrenceUID, lastDtStartDateTimeType, organizerProperty, previousStreamValue, rDateProperty, relatedToProperty, rRuleProperty, sequenceProperty, setCategories, setComment, setDateTimeCreated, setDateTimeLastModified, setDateTimeRecurrence, setDateTimeStamp, setDateTimeStart, setEndRange, setExDate, setExDatesOnOneLine, setGoogleRecurrenceUID, setOrganizer, setParent, setRDate, setRelatedTo, setRRule, setSequence, setStartRange, setSummary, setUidGeneratorCallback, setUniqueIdentifier, setUniqueIdentifier, stream, summaryProperty, uniqueIdentifierProperty, withCategories, withDateTimeCreated, withDateTimeLastModified, withDateTimeRecurrence, withDateTimeStamp, withDateTimeStart, withEndRange, withExDate, withOrganizer, withParent, withRDate, withRelatedTo, withRRule, withSequence, withStartRange, withSummary, withSummary, withUniqueIdentifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jfxtras.labs.icalendar.components.VComponent

countVComponents, errorString, findRelatedVComponents, findRelatedVComponents2, getDateTimeType, getZoneId, incrementSequence, isFirstRecurrence, isIndividual, isLastRecurrence, isRecurrenceSetEmpty, isStreamValue, isWholeDay, lastRecurrence

Constructor Detail

VTodo

public VTodo()

Method Detail

isValid

public boolean isValid()

Description copied from interface: VComponent

Checks to see if VComponent is has all required properties filled. Also checks to ensure all properties contain valid values.

Requires properties: DTSTAMP UID

Optional, can only occur once: // TODO - VERIFY ALL BELOW ITEMS DONE ONLY ONCE CLASS CREATED DTSTART LAST-MODIFIED ORGANIZER RECURID RRULE SEQUENCE STATUS SUMMARY URL

Returns:

true for valid VComponent, false for invalid one

makeInstances

public java.util.Collection<I> makeInstances(java.time.temporal.Temporal start,
                                             java.time.temporal.Temporal end)

Description copied from interface: VComponent

Returns the collection of recurrence instances of calendar component of type T that exists between dateTimeRangeStart and dateTimeRangeEnd based on VComponent. Recurrence set is defined in RFC 5545 iCalendar page 121 as follows "The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial "DTSTART" property along with the "RRULE", "RDATE", and "EXDATE" properties contained within the recurring component."

Parameters:

start - - beginning of time frame to make instances

end - - end of time frame to make instances

Returns:

makeInstances

public java.util.Collection<I> makeInstances()

Description copied from interface: VComponent

Returns the collection of recurrence instances of calendar component of type T that exists between dateTimeRangeStart and dateTimeRangeEnd based on VComponent. Recurrence set is defined in RFC 5545 iCalendar page 121 as follows "The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial "DTSTART" property along with the "RRULE", "RDATE", and "EXDATE" properties contained within the recurring component."

Uses start and end values from a previous call to makeInstances(Temporal start, Temporal end) If there are no start and end values an exception is thrown.

Returns:

instances

public java.util.Collection<I> instances()

Description copied from class: VComponentBase

The currently generated instances of the recurrence set. 3.8.5.2 defines the recurrence set as the complete set of recurrence instances for a calendar component. As many RRule definitions are infinite sets, a complete representation is not possible. The set only contains the events inside the bounds of

Specified by:

instances in interface VComponent<I>

Overrides:

instances in class VComponentBase<I,T>

Returns:

See Also:

makeRecurrenceSet

toComponentText

public java.lang.String toComponentText()

Description copied from interface: VComponent

returns string of line-separated properties defining calendar component.

Example:<br> BEGIN:VEVENT<br> DTSTART;TZID=America/Los_Angeles:20160214T080000<br> DTEND;TZID=America/Los_Angeles:20160214T110000<br> RRULE:FREQ=WEEKLY;BYDAY=SU,TU,FR<br> DTSTAMP:20160214T022532Z<br> UID:im8hmpakeigu3d85j3vq9q8bcc@google.com<br> CREATED:20160214T022525Z<br> LAST-MODIFIED:20160214T022525Z<br> SUMMARY:test2<br> END:VEVENT

streamLimitedByRange

public java.util.stream.Stream<java.time.temporal.Temporal> streamLimitedByRange()

Description copied from interface: VComponent

Produces a stream of start dates or date/times by calling VComponent.stream(Temporal) using VComponent.getStartRange() as the temporal parameter, minus the duration if the VComponent has one. This stream is used by VComponent.makeInstances() to produce the displayed instances of the recurrence set.

Returns: