Class RecurrenceRuleValue

java.lang.Object

jfxtras.icalendarfx.VElementBase

jfxtras.icalendarfx.VParentBase<RecurrenceRuleValue>

jfxtras.icalendarfx.properties.component.recurrence.rrule.RecurrenceRuleValue

All Implemented Interfaces:

VChild, VElement, VParent

public class RecurrenceRuleValue
extends VParentBase<RecurrenceRuleValue>
implements VChild

RRULE Recurrence Rule RFC 5545 iCalendar 3.3.10 page 38 Contains the following Recurrence Rule elements: COUNT UNTIL FREQUENCY INTERVAL BYxxx RULES in a List The value part of the recurrence rule. It supports the following elements:
( "FREQ" "=" freq )
( "UNTIL" "=" enddate )
( "COUNT" "=" 1*DIGIT )
( "INTERVAL" "=" 1*DIGIT )
( "BYSECOND" "=" byseclist )
( "BYMINUTE" "=" byminlist )
( "BYHOUR" "=" byhrlist )
( "BYDAY" "=" bywdaylist )
( "BYMONTHDAY" "=" bymodaylist )
( "BYYEARDAY" "=" byyrdaylist )
( "BYWEEKNO" "=" bywknolist )
( "BYMONTH" "=" bymolist )
( "BYSETPOS" "=" bysplist )
( "WKST" "=" weekday )
In addition to methods to support iCalendar recurrence rule parts, there is a method streamRecurrences(Temporal) that produces a stream of start date/times for the recurrences defined by the rule.

Author:

David Bal

See Also:

• RecurrenceRule

Nested Class Summary

Nested classes/interfaces inherited from class VElementBase

VElementBase.Message, VElementBase.MessageEffect

Field Summary

Fields inherited from class VParentBase

contentLineGenerator, orderer

Fields inherited from class VElementBase

BEGIN, END

Constructor Summary

Constructors

Constructor	Description
RecurrenceRuleValue()
RecurrenceRuleValue(RecurrenceRuleValue source)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkChild(List<VElementBase.Message> messages, String content, String elementName, VChild newChild)
List<String>	errors()	Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent
List<ByRule<?>>	getByRules()	BYxxx Rules RFC 5545, iCalendar 3.3.10 Page 42 List contains any of the following.
Count	getCount()
Frequency	getFrequency()
protected Method	getGetter(VChild child)
Interval	getInterval()
VParent	getParent()	Gets the VParent of this VChild
protected Method	getSetter(VChild child)
Until	getUntil()
WeekStart	getWeekStart()
boolean	isInfinite()	Determines if recurrence set is goes on forever
ByRule<?>	lookupByRule(Class<ByDay> class1)	Return particular ByRule of passed class
String	name()	Returns the name of the component as it would appear in the iCalendar content line.
static RecurrenceRuleValue	parse(String content)
protected List<VElementBase.Message>	parseContent(String contentLine)	Parse component from content line
void	setByRules(String... byRules)
void	setByRules(List<ByRule<?>> byRules)
void	setCount(int count)
void	setCount(Count count)
void	setFrequency(String frequency)
void	setFrequency(Frequency frequency)
void	setFrequency(FrequencyType frequency)
void	setInterval(Integer interval)
void	setInterval(Interval interval)
void	setParent(VParent parent)	Set the VParent of this VChild.
void	setUntil(String until)
void	setUntil(Temporal until)
void	setUntil(Until until)
void	setWeekStart(DayOfWeek weekStart)
void	setWeekStart(WeekStart weekStart)
Stream<Temporal>	streamRecurrences(Temporal start)	STREAM RECURRENCES Resulting stream of start date/times by applying Frequency temporal adjuster and all, if any, Starts on startDateTime, which MUST be a valid occurrence date/time, but not necessarily the first date/time (DTSTART) in the sequence.
String	toString()
RecurrenceRuleValue	withByRules(String... byRules)
RecurrenceRuleValue	withByRules(Collection<ByRule<?>> byRules)
RecurrenceRuleValue	withByRules(ByRule<?>... byRules)
RecurrenceRuleValue	withCount(int count)
RecurrenceRuleValue	withCount(Count count)
RecurrenceRuleValue	withFrequency(String frequency)
RecurrenceRuleValue	withFrequency(Frequency frequency)
RecurrenceRuleValue	withFrequency(FrequencyType frequency)
RecurrenceRuleValue	withInterval(int interval)
RecurrenceRuleValue	withInterval(Interval interval)
RecurrenceRuleValue	withUntil(String until)
RecurrenceRuleValue	withUntil(Temporal until)
RecurrenceRuleValue	withUntil(Until until)
RecurrenceRuleValue	withWeekStart(DayOfWeek weekStart)
RecurrenceRuleValue	withWeekStart(WeekStart weekStart)

Methods inherited from class VParentBase

addChild, addChild, addChild, addChildInternal, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, equals, getGetters, getSetters, hashCode, orderChild, orderChild, orderChild, parseContent, processInLineChild, removeChild, removeChild, replaceChild, replaceChild, withChild

Methods inherited from class VElementBase

elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions

Methods inherited from class Object

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

Methods inherited from interface VElement

isValid

Constructor Details

RecurrenceRuleValue

public RecurrenceRuleValue()

RecurrenceRuleValue

public RecurrenceRuleValue(RecurrenceRuleValue source)

Method Details

setParent

public void setParent(VParent parent)

Description copied from interface: VChild

Set the VParent of this VChild. This method is invoked internally by the API. Under normal circumstances it should not be used externally

Specified by:

setParent in interface VChild

getParent

public VParent getParent()

Description copied from interface: VChild

Gets the VParent of this VChild

Specified by:

getParent in interface VChild

name

public String name()

Description copied from interface: VElement

Returns the name of the component as it would appear in the iCalendar content line.

Examples:

• VEVENT
• SUMMARY
• LANGUAGE

Specified by:

name in interface VElement

Returns:

- the component name

getByRules

public List<ByRule<?>> getByRules()

BYxxx Rules RFC 5545, iCalendar 3.3.10 Page 42 List contains any of the following. The following list also indicates the processing order: ByMonth

invalid reference

ByWeekNo

ByYearDay ByMonthDay ByDay ByHour ByMinute BySecond

invalid reference

BySetPos

BYxxx rules modify the recurrence set by either expanding or limiting it. Each BYxxx rule can only occur once

setByRules

public void setByRules(List<ByRule<?>> byRules)

setByRules

public void setByRules(String... byRules)

withByRules

public RecurrenceRuleValue withByRules(Collection<ByRule<?>> byRules)

withByRules

public RecurrenceRuleValue withByRules(ByRule<?>... byRules)

withByRules

public RecurrenceRuleValue withByRules(String... byRules)

lookupByRule

public ByRule<?> lookupByRule(Class<ByDay> class1)

Return particular ByRule of passed class

getCount

public Count getCount()

setCount

public void setCount(Count count)

setCount

public void setCount(int count)

withCount

public RecurrenceRuleValue withCount(Count count)

withCount

public RecurrenceRuleValue withCount(int count)

getFrequency

public Frequency getFrequency()

setFrequency

public void setFrequency(Frequency frequency)

setFrequency

public void setFrequency(String frequency)

setFrequency

public void setFrequency(FrequencyType frequency)

withFrequency

public RecurrenceRuleValue withFrequency(Frequency frequency)

withFrequency

public RecurrenceRuleValue withFrequency(String frequency)

withFrequency

public RecurrenceRuleValue withFrequency(FrequencyType frequency)

getInterval

public Interval getInterval()

setInterval

public void setInterval(Interval interval)

setInterval

public void setInterval(Integer interval)

withInterval

public RecurrenceRuleValue withInterval(int interval)

withInterval

public RecurrenceRuleValue withInterval(Interval interval)

getUntil

public Until getUntil()

setUntil

public void setUntil(Until until)

setUntil

public void setUntil(Temporal until)

setUntil

public void setUntil(String until)

withUntil

public RecurrenceRuleValue withUntil(Temporal until)

withUntil

public RecurrenceRuleValue withUntil(String until)

withUntil

public RecurrenceRuleValue withUntil(Until until)

getWeekStart

public WeekStart getWeekStart()

setWeekStart

public void setWeekStart(WeekStart weekStart)

setWeekStart

public void setWeekStart(DayOfWeek weekStart)

withWeekStart

public RecurrenceRuleValue withWeekStart(WeekStart weekStart)

withWeekStart

public RecurrenceRuleValue withWeekStart(DayOfWeek weekStart)

getSetter

protected Method getSetter(VChild child)

Overrides:

getSetter in class VParentBase<RecurrenceRuleValue>

getGetter

protected Method getGetter(VChild child)

Overrides:

getGetter in class VParentBase<RecurrenceRuleValue>

parseContent

protected List<VElementBase.Message> parseContent(String contentLine)

Parse component from content line

Overrides:

parseContent in class VParentBase<RecurrenceRuleValue>

Parameters:

contentLine - calendar content string to parse

Returns:

log of information and error messages

streamRecurrences

public Stream<Temporal> streamRecurrences(Temporal start)

STREAM RECURRENCES Resulting stream of start date/times by applying Frequency temporal adjuster and all, if any, 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:

isInfinite

public boolean isInfinite()

Determines if recurrence set is goes on forever

Returns:

- true if recurrence set is infinite, false otherwise

toString

public String toString()

Overrides:

toString in class VParentBase<RecurrenceRuleValue>

errors

public List<String> errors()

Description copied from interface: VElement

Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent

Specified by:

errors in interface VElement

Overrides:

errors in class VParentBase<RecurrenceRuleValue>

Returns:

- list of error messages

checkChild

protected boolean checkChild(List<VElementBase.Message> messages,
 String content,
 String elementName,
 VChild newChild)

Overrides:

checkChild in class VParentBase<RecurrenceRuleValue>

parse

public static RecurrenceRuleValue parse(String content)