biweekly.property

Class RecurrenceRule

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<Recurrence>

biweekly.property.RecurrenceProperty

biweekly.property.RecurrenceRule

public class RecurrenceRule
extends RecurrenceProperty

Defines how often a component repeats.

Code sample:

 VEvent event = new VEvent();
 
 Recurrence recur = new Recurrence.Builder(Frequency.WEEKLY).interval(2).build();
 RecurrenceRule rrule = new RecurrenceRule(recur);
 event.setRecurrenceRule(rruel);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.122-32

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
RecurrenceRule(Recurrence recur) Creates a new recurrence rule property.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	validate(List<ICalComponent> components, List<Warning> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ValuedProperty

getValue, setValue

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecurrenceRule

public RecurrenceRule(Recurrence recur)

Creates a new recurrence rule property.

Parameters:

recur - the recurrence rule

Method Detail

validate

protected void validate(List<ICalComponent> components,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.

Overrides:

validate in class RecurrenceProperty

Parameters:

components - the hierarchy of components that the property belongs to

warnings - the list to add the warnings to