com.google.ical.values

Class RRule

java.lang.Object

com.google.ical.values.RRule

All Implemented Interfaces:

IcalObject

public class RRule
extends java.lang.Object

encapsulates an RFC 2445 RRULE or EXRULE.

Constructor Summary

Constructors

Constructor and Description
RRule()
RRule(java.lang.String icalString)

Method Summary

Methods

Modifier and Type	Method and Description
int	approximateIntervalInDays() an approximate number of days between occurences.
java.util.List<WeekdayNum>	getByDay()
int[]	getByHour()
int[]	getByMinute()
int[]	getByMonth()
int[]	getByMonthDay()
int[]	getBySecond()
int[]	getBySetPos()
int[]	getByWeekNo()
int[]	getByYearDay()
int	getCount()
java.util.Map<java.lang.String,java.lang.String>	getExtParams() a map of any extension parameters such as the X-FOO=BAR in RRULE;X-FOO=BAR.
Frequency	getFreq() the frequency of repetition
int	getInterval()
java.lang.String	getName() the object name such as RRULE, EXRULE, VEVENT.
DateValue	getUntil()
Weekday	getWkSt() day of the week the week starts on
boolean	hasExtParams()
protected void	parse(java.lang.String icalString, com.google.ical.values.IcalSchema schema) parse the ical object from the given ical content using the given schema.
void	setByDay(java.util.List<WeekdayNum> byDay)
void	setByHour(int[] byHour)
void	setByMinute(int[] byMinute)
void	setByMonth(int[] byMonth)
void	setByMonthDay(int[] byMonthDay)
void	setBySecond(int[] bySecond)
void	setBySetPos(int[] bySetPos)
void	setByWeekNo(int[] byWeekNo)
void	setByYearDay(int[] byYearDay)
void	setCount(int count)
void	setFreq(Frequency freq)
void	setInterval(int interval)
void	setName(java.lang.String name)
void	setUntil(DateValue until)
void	setWkSt(Weekday wkst)
java.lang.String	toIcal() formats as an *unfolded* RFC 2445 content line.

Methods inherited from class java.lang.Object

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

Constructor Detail

RRule

public RRule()

RRule

public RRule(java.lang.String icalString)
      throws java.text.ParseException

Throws:

java.text.ParseException

Method Detail

toIcal

public java.lang.String toIcal()

formats as an *unfolded* RFC 2445 content line.

approximateIntervalInDays

public int approximateIntervalInDays()

an approximate number of days between occurences.

getFreq

public Frequency getFreq()

the frequency of repetition

setFreq

public void setFreq(Frequency freq)

getWkSt

public Weekday getWkSt()

day of the week the week starts on

setWkSt

public void setWkSt(Weekday wkst)

getUntil

public DateValue getUntil()

setUntil

public void setUntil(DateValue until)

getCount

public int getCount()

setCount

public void setCount(int count)

getInterval

public int getInterval()

setInterval

public void setInterval(int interval)

getByDay

public java.util.List<WeekdayNum> getByDay()

setByDay

public void setByDay(java.util.List<WeekdayNum> byDay)

getByMonth

public int[] getByMonth()

setByMonth

public void setByMonth(int[] byMonth)

getByMonthDay

public int[] getByMonthDay()

setByMonthDay

public void setByMonthDay(int[] byMonthDay)

getByWeekNo

public int[] getByWeekNo()

setByWeekNo

public void setByWeekNo(int[] byWeekNo)

getByYearDay

public int[] getByYearDay()

setByYearDay

public void setByYearDay(int[] byYearDay)

getBySetPos

public int[] getBySetPos()

setBySetPos

public void setBySetPos(int[] bySetPos)

getByHour

public int[] getByHour()

setByHour

public void setByHour(int[] byHour)

getByMinute

public int[] getByMinute()

setByMinute

public void setByMinute(int[] byMinute)

getBySecond

public int[] getBySecond()

setBySecond

public void setBySecond(int[] bySecond)

parse

protected void parse(java.lang.String icalString,
         com.google.ical.values.IcalSchema schema)
              throws java.text.ParseException

parse the ical object from the given ical content using the given schema. Modifies the current object in place.

Parameters:

schema - rules for processing individual parameters and body content.

Throws:

java.text.ParseException

getName

public java.lang.String getName()

the object name such as RRULE, EXRULE, VEVENT. @see #setName

Specified by:

getName in interface IcalObject

setName

public void setName(java.lang.String name)

See Also:

getName()

getExtParams

public java.util.Map<java.lang.String,java.lang.String> getExtParams()

a map of any extension parameters such as the X-FOO=BAR in RRULE;X-FOO=BAR. Maps the parameter name, X-FOO, to the parameter value, BAR.

Specified by:

getExtParams in interface IcalObject

hasExtParams

public boolean hasExtParams()