jfxtras.labs.icalendar.properties.recurrence.rrule.freq

Interface Frequency

All Known Implementing Classes:

Daily, FrequencyAbstract, Hourly, Minutely, Monthly, Secondly, Weekly, Yearly

public interface Frequency

Interface for frequency rule that produces a stream of LocalDateTime start times for repeatable events FREQ rule as defined in RFC 5545 iCalendar 3.3.10 p37 (i.e. Daily, Weekly, Monthly, etc.)

See Also:

FrequencyAbstract, Yearly, Monthly, Weekly, Daily, Hourly, Minutely, Secondly

Property Summary

Type	Property and Description
javafx.beans.property.IntegerProperty	interval Number of frequency periods elapsed before next occurrence.

Method Summary

Modifier and Type	Method and Description
java.time.temporal.TemporalAdjuster	adjuster() Temporal adjuster every class implementing Frequency must provide that modifies frequency dates For example, Weekly class advances the dates by INTERVAL Number of weeks.
javafx.collections.ObservableList<ByRule>	byRules() Collection of rules that modify frequency rule (see RFC 5545, iCalendar 3.3.10 Page 42) The rules include all BYxxx rules, EXDate and RDate lists.
FrequencyUtilities.FrequencyEnum	frequencyType() Which of the enum type FrenquencyType the implementing class represents
java.lang.Integer	getInterval() Number of frequency periods elapsed before next occurrence.
javafx.beans.property.IntegerProperty	intervalProperty() Number of frequency periods elapsed before next occurrence.
default ByRule	lookupByRule(ByRuleEnum byRuleType)
default java.lang.String	makeErrorString() Deprecated.
default java.time.temporal.Temporal	makeFrequencyOccurrence(java.time.temporal.Temporal dateTimeStart, java.time.temporal.Temporal start) Deprecated.
void	setInterval(java.lang.Integer interval) Number of frequency periods elapsed before next occurrence.
java.util.stream.Stream<java.time.temporal.Temporal>	stream(java.time.temporal.Temporal start) Resulting stream of start date/times by applying Frequency temporal adjuster and all, if any, Rules.

Property Detail

interval

javafx.beans.property.IntegerProperty intervalProperty

Number of frequency periods elapsed before next occurrence. Defaults to 1

See Also:

getInterval(), setInterval(Integer)

Method Detail

getInterval

java.lang.Integer getInterval()

Number of frequency periods elapsed before next occurrence. Defaults to 1

setInterval

void setInterval(java.lang.Integer interval)

Number of frequency periods elapsed before next occurrence. Defaults to 1

intervalProperty

javafx.beans.property.IntegerProperty intervalProperty()

Number of frequency periods elapsed before next occurrence. Defaults to 1

See Also:

getInterval(), setInterval(Integer)

byRules

javafx.collections.ObservableList<ByRule> byRules()

Collection of rules that modify frequency rule (see RFC 5545, iCalendar 3.3.10 Page 42) The rules include all BYxxx rules, EXDate and RDate lists. The BYxxx rules must be applied in a specific order and can only be occur once BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.

lookupByRule

default ByRule lookupByRule(ByRuleEnum byRuleType)

stream

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

Resulting stream of start date/times by applying Frequency temporal adjuster and all, if any, Rules. Starts on startDateTime, which MUST be a valid occurrence date/time, but not necessarily the first date/time (DTSTART) in the sequence. A later startDateTime can be used to more efficiently get to later dates in the stream.

Parameters:

start - - starting point of stream (MUST be a valid occurrence date/time)

Returns:

frequencyType

FrequencyUtilities.FrequencyEnum frequencyType()

Which of the enum type FrenquencyType the implementing class represents

adjuster

java.time.temporal.TemporalAdjuster adjuster()

Temporal adjuster every class implementing Frequency must provide that modifies frequency dates For example, Weekly class advances the dates by INTERVAL Number of weeks.

makeFrequencyOccurrence

@Deprecated
default java.time.temporal.Temporal makeFrequencyOccurrence(java.time.temporal.Temporal dateTimeStart,
                                                                         java.time.temporal.Temporal start)

Deprecated.

Find previous occurrence date to start the stream

Parameters:

dateTimeStart - - DTSTART

start -

Returns:

makeErrorString

@Deprecated
default java.lang.String makeErrorString()

Deprecated.

Checks to see if object contains required properties. Returns empty string if it is valid. Returns string of errors if not valid.