Interface ByRule<T>

All Superinterfaces:

Comparable<ByRule<T>>, RRulePart<T>, VChild, VElement

All Known Implementing Classes:

ByDay, ByHour, ByMinute, ByMonth, ByMonthDay, ByRuleAbstract, ByRuleIntegerAbstract, BySecond, BySetPosition, ByWeekNumber, ByYearDay

public interface ByRule<T>
extends Comparable<ByRule<T>>, RRulePart<T>

Interface for a rule that applies a modification to a Stream of start date/times, such as BYxxx rules, in a recurring event (RRULE).

See Also:

• ByRuleAbstract
• ByMonth
• ByWeekNumber
• ByYearDay
• ByMonthDay
• ByDay
• ByHour
• ByMinute
• BySecond
• BySetPosition

Method Summary

Modifier and Type	Method	Description
Stream<Temporal>	streamRecurrences(Stream<Temporal> inStream, ChronoUnit chronoUnit, Temporal dateTimeStart)	New stream of date/times made after applying rule that either filters out some date/times or adds additional date/times.

Methods inherited from interface Comparable

compareTo

Methods inherited from interface RRulePart

getValue, setValue

Methods inherited from interface VChild

getParent, setParent

Methods inherited from interface VElement

errors, isValid, name

Method Details

streamRecurrences

Stream<Temporal> streamRecurrences(Stream<Temporal> inStream,
 ChronoUnit chronoUnit,
 Temporal dateTimeStart)

New stream of date/times made after applying rule that either filters out some date/times or adds additional date/times.

Parameters:

inStream - - Current stream to be added to or subtracted from

chronoUnit - - ChronoUnit of last modification to inStream

startTemporal - - start Temporal (date or date/time)

Returns: