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

Class FrequencyAbstract<T>

java.lang.Object

jfxtras.labs.icalendar.properties.recurrence.rrule.freq.FrequencyAbstract<T>

All Implemented Interfaces:

Frequency

Direct Known Subclasses:

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

public abstract class FrequencyAbstract<T>
extends java.lang.Object
implements Frequency

Property Summary

Type	Property and Description
javafx.beans.property.IntegerProperty	interval INTERVAL: (RFC 5545 iCalendar 3.3.10, page 40) number of frequency periods to pass before new appointment

Constructor Summary

Constructors

Constructor and Description
FrequencyAbstract(Frequency source)
FrequencyAbstract(FrequencyUtilities.FrequencyEnum frequencyType)

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() BYxxx Rules Collection of BYxxx rules that modify frequency rule (see RFC 5545, iCalendar 3.3.10 Page 42) Each BYxxx rule can only occur once
boolean	equals(java.lang.Object obj)
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.
int	hashCode()
javafx.beans.property.IntegerProperty	intervalProperty() INTERVAL: (RFC 5545 iCalendar 3.3.10, page 40) number of frequency periods to pass before new appointment
void	setChronoUnit(java.time.temporal.ChronoUnit chronoUnit)
void	setInterval(java.lang.Integer i) 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.
java.lang.String	toString()
T	withByRules(ByRule... byRules) Add varargs of ByRules to Frequency Collection of BYxxx rules that modify frequency rule (see RFC 5545, iCalendar 3.3.10 Page 42) Each BYxxx rule can only occur once
T	withInterval(int interval)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jfxtras.labs.icalendar.properties.recurrence.rrule.freq.Frequency

lookupByRule, makeErrorString, makeFrequencyOccurrence

Property Detail

interval

public javafx.beans.property.IntegerProperty intervalProperty

INTERVAL: (RFC 5545 iCalendar 3.3.10, page 40) number of frequency periods to pass before new appointment

Specified by:

intervalProperty in interface Frequency

See Also:

getInterval(), setInterval(Integer)

Constructor Detail

FrequencyAbstract

public FrequencyAbstract(FrequencyUtilities.FrequencyEnum frequencyType)

FrequencyAbstract

public FrequencyAbstract(Frequency source)

Method Detail

intervalProperty

public javafx.beans.property.IntegerProperty intervalProperty()

INTERVAL: (RFC 5545 iCalendar 3.3.10, page 40) number of frequency periods to pass before new appointment

Specified by:

intervalProperty in interface Frequency

See Also:

getInterval(), setInterval(Integer)

getInterval

public java.lang.Integer getInterval()

Description copied from interface: Frequency

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

Specified by:

getInterval in interface Frequency

setInterval

public void setInterval(java.lang.Integer i)

Description copied from interface: Frequency

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

Specified by:

setInterval in interface Frequency

withInterval

public T withInterval(int interval)

byRules

public javafx.collections.ObservableList<ByRule> byRules()

BYxxx Rules Collection of BYxxx rules that modify frequency rule (see RFC 5545, iCalendar 3.3.10 Page 42) Each BYxxx rule can only occur once

Specified by:

byRules in interface Frequency

withByRules

public T withByRules(ByRule... byRules)

Add varargs of ByRules to Frequency Collection of BYxxx rules that modify frequency rule (see RFC 5545, iCalendar 3.3.10 Page 42) Each BYxxx rule can only occur once

setChronoUnit

public void setChronoUnit(java.time.temporal.ChronoUnit chronoUnit)

frequencyType

public FrequencyUtilities.FrequencyEnum frequencyType()

Description copied from interface: Frequency

Which of the enum type FrenquencyType the implementing class represents

Specified by:

frequencyType in interface Frequency

adjuster

public java.time.temporal.TemporalAdjuster adjuster()

Description copied from interface: Frequency

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

Specified by:

adjuster in interface Frequency

stream

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

Description copied from interface: Frequency

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.

Specified by:

stream in interface Frequency

Parameters:

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

Returns:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object