biweekly.property
Class RecurrenceRule

java.lang.Object
  biweekly.property.ICalProperty
      biweekly.property.RecurrenceRule

public class RecurrenceRule
extends ICalProperty

Defines how often a component repeats.

Examples:

 //bi-weekly
 RecurrenceRule rrule = new RecurrenceRule(Frequency.WEEKLY);
 rrule.setInterval(2);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.122-32

Nested Class Summary

static class	RecurrenceRule.DayOfWeek Represents each of the seven days of the week.
static class	RecurrenceRule.Frequency Represents the frequency at which the recurrence rule repeats itself.

Field Summary

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

RecurrenceRule(RecurrenceRule.Frequency frequency)
Creates a new recurrence rule property.

Method Summary

void	addByDay(Integer prefix, RecurrenceRule.DayOfWeek day)
void	addByDay(RecurrenceRule.DayOfWeek day)
List<RecurrenceRule.DayOfWeek>	getByDay()
List<Integer>	getByDayPrefixes()
List<Integer>	getByHour()
List<Integer>	getByMinute()
List<Integer>	getByMonth()
List<Integer>	getByMonthDay()
List<Integer>	getBySecond()
List<Integer>	getBySetPos()
List<Integer>	getByWeekNo()
List<Integer>	getByYearDay()
Integer	getCount()
RecurrenceRule.Frequency	getFrequency()
Integer	getInterval()
Date	getUntil()
RecurrenceRule.DayOfWeek	getWorkweekStarts()
boolean	hasTimeUntilDate()
void	setByHour(List<Integer> byHour)
void	setByMinute(List<Integer> byMinute)
void	setByMonth(List<Integer> byMonth)
void	setByMonthDay(List<Integer> byMonthDay)
void	setBySecond(List<Integer> bySecond)
void	setBySetPos(List<Integer> bySetPos)
void	setByWeekNo(List<Integer> byWeekNo)
void	setByYearDay(List<Integer> byYearDay)
void	setCount(Integer count)
void	setFrequency(RecurrenceRule.Frequency frequency)
void	setInterval(Integer interval)
void	setUntil(Date until)
void	setUntil(Date until, boolean hasTime)
void	setWorkweekStarts(RecurrenceRule.DayOfWeek workweekStarts)
protected void	validate(List<ICalComponent> components, List<String> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getAltRepresentation, getCommonName, getDirectoryEntry, getFormatType, getLanguage, getParameter, getParameters, getParameters, getSentBy, getTimezoneId, removeParameter, setAltRepresentation, setCommonName, setDirectoryEntry, setFormatType, setLanguage, setParameter, setParameter, setParameters, setSentBy, setTimezone, setTimezoneId, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurrenceRule

public RecurrenceRule(RecurrenceRule.Frequency frequency)

Creates a new recurrence rule property.

Parameters:

frequency - the frequency of the recurrence rule

Method Detail

getFrequency

public RecurrenceRule.Frequency getFrequency()

setFrequency

public void setFrequency(RecurrenceRule.Frequency frequency)

getUntil

public Date getUntil()

setUntil

public void setUntil(Date until)

setUntil

public void setUntil(Date until,
                     boolean hasTime)

hasTimeUntilDate

public boolean hasTimeUntilDate()

getCount

public Integer getCount()

setCount

public void setCount(Integer count)

getInterval

public Integer getInterval()

setInterval

public void setInterval(Integer interval)

getBySecond

public List<Integer> getBySecond()

setBySecond

public void setBySecond(List<Integer> bySecond)

getByMinute

public List<Integer> getByMinute()

setByMinute

public void setByMinute(List<Integer> byMinute)

getByHour

public List<Integer> getByHour()

setByHour

public void setByHour(List<Integer> byHour)

addByDay

public void addByDay(RecurrenceRule.DayOfWeek day)

addByDay

public void addByDay(Integer prefix,
                     RecurrenceRule.DayOfWeek day)

getByDay

public List<RecurrenceRule.DayOfWeek> getByDay()

getByDayPrefixes

public List<Integer> getByDayPrefixes()

getByMonthDay

public List<Integer> getByMonthDay()

setByMonthDay

public void setByMonthDay(List<Integer> byMonthDay)

getByYearDay

public List<Integer> getByYearDay()

setByYearDay

public void setByYearDay(List<Integer> byYearDay)

getByWeekNo

public List<Integer> getByWeekNo()

setByWeekNo

public void setByWeekNo(List<Integer> byWeekNo)

getByMonth

public List<Integer> getByMonth()

setByMonth

public void setByMonth(List<Integer> byMonth)

getBySetPos

public List<Integer> getBySetPos()

setBySetPos

public void setBySetPos(List<Integer> bySetPos)

getWorkweekStarts

public RecurrenceRule.DayOfWeek getWorkweekStarts()

setWorkweekStarts

public void setWorkweekStarts(RecurrenceRule.DayOfWeek workweekStarts)

validate

protected void validate(List<ICalComponent> components,
                        List<String> 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.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

warnings - the list to add the warnings to