RecurrenceRule

Inheritance: java.lang.Object

public class RecurrenceRule

Represents one recurrence or exception rule in a recurrence pattern.


Corresponds to RRULE or EXRULE part in iCalendar.
 To construct a recurrence rule, you typically need to:
 1. Specify the type of the rule in ```
Frequency
```.
 2. Specify how the recurrence pattern ends using ```
EndType
```,

Count or Until

 3. Specify values in one or more ByXXX collections.
 Note, that if ByXXX rule part values are found which are beyond the available
 scope (ie, BYMONTHDAY=30 in February), they are simply ignored.

 Information, not contained in the rule, necessary to determine the various recurrence instance 
 start time and dates are derived from ```
CalendarRecurrence.StartDate
```. For example,
 "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information 
 would be the same as what is specified for DTSTART.

 ByXXX rule parts modify the recurrence in some manner. ByXXX rule parts for a period of time which is 
 the same or greater than the frequency generally reduce or limit the number of occurrences of the
 recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances 
 from all days (if BYMONTH tag is not present) to all days in January. ByXXX rule parts for a period of
 time less than the frequency generally increase or expand the number of occurrences of the recurrence. 
 For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set 
 from 1 (if BYMONTH tag is not present) to 2.

 If multiple ByXXX rule parts are specified, then after evaluating the specified Frequency and Interval
 rule parts, the ByXXX rule parts are applied to the current set of evaluated occurrences in the following
 order: ```
ByMonth
```, ```
ByWeekNo
```, ```
ByYearDay
```, ```
ByMonthDay
```, 

ByDay , ByHour , ByMinute , BySecond

BySetPos ; then Count and Until

Constructors

Constructor Description
RecurrenceRule() Initializes a new instance of the RecurrenceRule class.

Methods

Method Description
getFriendlyText() Gets user friendly text of rule.
getWeekStart() Gets or sets the starting day of the week.
setWeekStart(int value) Gets or sets the starting day of the week.
getFrequency() Gets or sets the type of the recurrence rule.
setFrequency(int value) Gets or sets the type of the recurrence rule.
getInterval() Gets or sets the interval.
setInterval(int value) Gets or sets the interval.
getEndType() Gets or sets the end type.
setEndType(int value) Gets or sets the end type.
getCount() Gets or sets the count.
setCount(int value) Gets or sets the count.
getUntil() Gets or sets the until.
setUntil(Date value) Gets or sets the until.
getBySecond() Gets the by second.
getByMinute() Gets the by minute.
getByHour() Gets the by hour.
getByMonth() Gets the by month.
getByDay() Gets the by day.
getBySetPos() Gets the by set pos.
getByMonthDay() Gets the by month day.
getByYearDay() Gets the by year day.
getByWeekNo() Gets the by week no.
equals(RecurrenceRule other) Determines whether the specified RecurrenceRule is equal to this instance.
equals(Object obj) Determines whether the specified Object is equal to the current Object.
hashCode() GetHashCode returns a hash function for this object.

RecurrenceRule()

public RecurrenceRule()

Initializes a new instance of the RecurrenceRule class.

getFriendlyText()

public final String getFriendlyText()

Gets user friendly text of rule.

Returns: java.lang.String

getWeekStart()

public final int getWeekStart()

Gets or sets the starting day of the week.

Returns: int

setWeekStart(int value)

public final void setWeekStart(int value)

Gets or sets the starting day of the week.

Parameters:

Parameter Type Description
value int

getFrequency()

public final int getFrequency()

Gets or sets the type of the recurrence rule.

Value: The frequency.

Returns: int

setFrequency(int value)

public final void setFrequency(int value)

Gets or sets the type of the recurrence rule.

Value: The frequency.

Parameters:

Parameter Type Description
value int

getInterval()

public final int getInterval()

Gets or sets the interval.

Value: The interval.

Returns: int

setInterval(int value)

public final void setInterval(int value)

Gets or sets the interval.

Value: The interval.

Parameters:

Parameter Type Description
value int

getEndType()

public final int getEndType()

Gets or sets the end type.

Value: The end type.

Returns: int

setEndType(int value)

public final void setEndType(int value)

Gets or sets the end type.

Value: The end type.

Parameters:

Parameter Type Description
value int

getCount()

public final int getCount()

Gets or sets the count.

Value: The count.

Returns: int

setCount(int value)

public final void setCount(int value)

Gets or sets the count.

Value: The count.

Parameters:

Parameter Type Description
value int

getUntil()

public final Date getUntil()

Gets or sets the until.

Value: The until.

Returns: java.util.Date

setUntil(Date value)

public final void setUntil(Date value)

Gets or sets the until.

Value: The until.

Parameters:

Parameter Type Description
value java.util.Date

getBySecond()

public final ByNumberCollection getBySecond()

Gets the by second.

Value: The by second.

Returns: ByNumberCollection

getByMinute()

public final ByNumberCollection getByMinute()

Gets the by minute.

Value: The by minute.

Returns: ByNumberCollection

getByHour()

public final ByNumberCollection getByHour()

Gets the by hour.

Value: The by hour.

Returns: ByNumberCollection

getByMonth()

public final ByNumberCollection getByMonth()

Gets the by month.

Value: The by month.

Returns: ByNumberCollection

getByDay()

public final ByDayCollection getByDay()

Gets the by day.

Value: The by day.

Returns: ByDayCollection

getBySetPos()

public final ByNumberCollection getBySetPos()

Gets the by set pos.

Value: The by set pos.

Returns: ByNumberCollection

getByMonthDay()

public final ByNumberCollection getByMonthDay()

Gets the by month day.

Value: The by month day.

Returns: ByNumberCollection

getByYearDay()

public final ByNumberCollection getByYearDay()

Gets the by year day.

Value: The by year day.

Returns: ByNumberCollection

getByWeekNo()

public final ByNumberCollection getByWeekNo()

Gets the by week no.

Value: The by week no.

Returns: ByNumberCollection

equals(RecurrenceRule other)

public boolean equals(RecurrenceRule other)

Determines whether the specified RecurrenceRule is equal to this instance.

Parameters:

Parameter Type Description
other RecurrenceRule The RecurrenceRule to compare with this instance.

Returns: boolean - ``` true ``` if the specified RecurrenceRule is equal to this instance; otherwise, ``` false ```.

equals(Object obj)

public boolean equals(Object obj)

Determines whether the specified Object is equal to the current Object.

Parameters:

Parameter Type Description
obj java.lang.Object The Object to compare with the current Object.

Returns: boolean - Returns a boolean indicating if the passed in object obj is Equal to this.

hashCode()

public int hashCode()

GetHashCode returns a hash function for this object.

Returns: int - Returns a hash function for this object.