com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class RecurrenceRule


  • public class RecurrenceRule
extends Object

    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 and 
 BySetPos; then Count and Until are evaluated.

    • Constructor Detail

      • RecurrenceRule

        public RecurrenceRule()

        Initializes a new instance of the RecurrenceRule class.

    • Method Detail

      • getFriendlyText

        public final String getFriendlyText()

        Gets user friendly text of rule.

      • getWeekStart

        public final int getWeekStart()

        Gets or sets the starting day of the week.

      • setWeekStart

        public final void setWeekStart(int value)

        Gets or sets the starting day of the week.

      • getFrequency

        public final int getFrequency()

        Gets or sets the type of the recurrence rule.

        Value: The frequency.

      • setFrequency

        public final void setFrequency(int value)

        Gets or sets the type of the recurrence rule.

        Value: The frequency.

      • getInterval

        public final int getInterval()

        Gets or sets the interval.

        Value: The interval.

      • setInterval

        public final void setInterval(int value)

        Gets or sets the interval.

        Value: The interval.

      • getEndType

        public final int getEndType()

        Gets or sets the end type.

        Value: The end type.

      • setEndType

        public final void setEndType(int value)

        Gets or sets the end type.

        Value: The end type.

      • getCount

        public final int getCount()

        Gets or sets the count.

        Value: The count.

      • setCount

        public final void setCount(int value)

        Gets or sets the count.

        Value: The count.

      • getUntil

        public final Date getUntil()

        Gets or sets the until.

        Value: The until.

      • setUntil

        public final void setUntil(Date value)

        Gets or sets the until.

        Value: The until.

      • getBySecond

        public final ByNumberCollection getBySecond()

        Gets the by second.

        Value: The by second.

      • getByMinute

        public final ByNumberCollection getByMinute()

        Gets the by minute.

        Value: The by minute.

      • getByHour

        public final ByNumberCollection getByHour()

        Gets the by hour.

        Value: The by hour.

      • getByMonth

        public final ByNumberCollection getByMonth()

        Gets the by month.

        Value: The by month.

      • getByDay

        public final ByDayCollection getByDay()

        Gets the by day.

        Value: The by day.

      • getBySetPos

        public final ByNumberCollection getBySetPos()

        Gets the by set pos.

        Value: The by set pos.

      • getByMonthDay

        public final ByNumberCollection getByMonthDay()

        Gets the by month day.

        Value: The by month day.

      • getByYearDay

        public final ByNumberCollection getByYearDay()

        Gets the by year day.

        Value: The by year day.

      • getByWeekNo

        public final ByNumberCollection getByWeekNo()

        Gets the by week no.

        Value: The by week no.

      • equals

        public boolean equals(RecurrenceRule other)

        Determines whether the specified RecurrenceRule is equal to this instance.

        Parameters:
        other - The RecurrenceRule to compare with this instance.
        Returns:
        true if the specified RecurrenceRule is equal to this instance; otherwise, false.

      • equals

        public boolean equals(Object obj)

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

        Overrides:
        equals in class Object
        Parameters:
        obj - The Object to compare with the current Object.
        Returns:
        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.

        Overrides:
        hashCode in class Object
        Returns:
        Returns a hash function for this object.