public class ByDay extends ByRuleAbstract
BYDAY from RFC 5545, iCalendar 3.3.10, page 40
Modifier and Type | Class and Description |
---|---|
static class |
ByDay.ByDayPair
Contains both the day of the week and an optional positive or negative integer (ordinal).
|
Constructor and Description |
---|
ByDay()
Parse iCalendar compliant list of days of the week.
|
ByDay(ByDay.ByDayPair... byDayPairs)
Constructor with varargs ByDayPair
|
ByDay(ByRule source) |
ByDay(java.util.Collection<java.time.DayOfWeek> daysOfWeeks)
Constructor that uses DayOfWeek Collection.
|
ByDay(java.time.DayOfWeek... daysOfWeek)
Constructor that uses DayOfWeek values without a preceding integer.
|
ByDay(java.lang.String dayPairs) |
Modifier and Type | Method and Description |
---|---|
void |
addDayOfWeek(java.time.DayOfWeek dayOfWeek)
add individual DayofWeek, without ordinal value, to BYDAY rule
|
void |
copyTo(ByRule destination) |
java.util.List<java.time.DayOfWeek> |
dayOfWeekWithoutOrdinalList()
Return a list of days of the week that don’t have an ordinal (as every FRIDAY)
|
boolean |
equals(java.lang.Object obj) |
ByDay.ByDayPair[] |
getByDayPairs()
Array of days of the week.
|
int |
hashCode() |
boolean |
hasOrdinals()
Checks if byDayPairs has ordinal values.
|
void |
removeDayOfWeek(java.time.DayOfWeek dayOfWeek)
remove individual DayofWeek from BYDAY rule
|
java.util.stream.Stream<java.time.temporal.Temporal> |
stream(java.util.stream.Stream<java.time.temporal.Temporal> inStream,
javafx.beans.property.ObjectProperty<java.time.temporal.ChronoUnit> chronoUnit,
java.time.temporal.Temporal startTemporal)
New stream of date/times made after applying rule that either filters out some date/times
or adds additional date/times.
|
java.lang.String |
toString() |
byRuleType, compareTo
public ByDay()
Parse iCalendar compliant list of days of the week. For example 1MO,2TU,4SA
public ByDay(java.lang.String dayPairs)
public ByDay(ByDay.ByDayPair... byDayPairs)
Constructor with varargs ByDayPair
public ByDay(ByRule source)
public ByDay(java.time.DayOfWeek... daysOfWeek)
Constructor that uses DayOfWeek values without a preceding integer. All days of the provided types are included within the specified frequency
public ByDay(java.util.Collection<java.time.DayOfWeek> daysOfWeeks)
Constructor that uses DayOfWeek Collection. No ordinals are allowed.
public ByDay.ByDayPair[] getByDayPairs()
Array of days of the week. Ordinal number is optional. Without will include all days matching that day of the week, with the ordinal will be only include the nth day of the week in the month, when n is the ordinal number.
Uses a varargs parameter to allow any number of days The list of days with ordinals must be sorted. For example 1MO,2TU,4SA not 2TU,1MO,4SA
public boolean hasOrdinals()
Checks if byDayPairs has ordinal values. If so returns true, otherwise false
public void addDayOfWeek(java.time.DayOfWeek dayOfWeek)
add individual DayofWeek, without ordinal value, to BYDAY rule
public void removeDayOfWeek(java.time.DayOfWeek dayOfWeek)
remove individual DayofWeek from BYDAY rule
public java.util.List<java.time.DayOfWeek> dayOfWeekWithoutOrdinalList()
Return a list of days of the week that don’t have an ordinal (as every FRIDAY)
public void copyTo(ByRule destination)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.stream.Stream<java.time.temporal.Temporal> stream(java.util.stream.Stream<java.time.temporal.Temporal> inStream, javafx.beans.property.ObjectProperty<java.time.temporal.ChronoUnit> chronoUnit, java.time.temporal.Temporal startTemporal)
ByRule
New stream of date/times made after applying rule that either filters out some date/times or adds additional date/times.
inStream
- - Current stream to be added to or subtracted fromchronoUnit
- - ChronoUnit of last modification to inStreamstartTemporal
- - start Temporal (date or date/time)