com.aspose.email

com.aspose.email

Class ByDay

public class ByDay
extends Object

Represents Nth occurrence (or all occurrences) of the specified day of the week.

Corresponds to one day of the week specified in the BYDAY part of a recurrence rule. Can be used in a monthly or yearly recurrence rule to specify Nth occurrence (or all occurrences) of the specified day of the week in a month or year. BYDAY=MO represents all Mondays of the month or year. To represent all occurrences, set NthOccurrence to 0. BYDAY=2MO represents 2nd Monday in a month or year. BYDAY=-1MO represents the last Monday of a month or year.

See Also:
ByDayCollection

Constructor Summary
ByDay(intdayOfWeek)
Initializes a new instance of ByDay class.
ByDay(intnthOccurrence, intdayOfWeek)
Initializes a new instance of ByDay class.
 
Method Summary
boolean
equals(ByDay other)
boolean
equals(Object obj)
int
getDayOfWeek()
Gets or sets the day of the week.
int
getNthOccurrence()
Gets or sets the nth occurrence of the day of the week.
int
boolean
isAllOccurrences()
Returns True when NthOccurrence is zero (meaning all occurrences of this day of week).
void
setDayOfWeek(intvalue)
void
setNthOccurrence(intvalue)
 
Methods inherited from class java.lang.Object
 

    • Constructor Detail

      • ByDay

        public ByDay(int dayOfWeek)

        Initializes a new instance of ByDay class.

        Parameters:
        dayOfWeek - A day of the week.
      • ByDay

        public ByDay(int nthOccurrence,
                     int dayOfWeek)

        Initializes a new instance of ByDay class.

        Parameters:
        nthOccurrence - The nth occurrence of the day of the week.
        dayOfWeek - A day of the week.
    • Method Detail

      • getNthOccurrence

        public int getNthOccurrence()

        Gets or sets the nth occurrence of the day of the week.

        Valid range for this property is from -53 to 53. Positive values represent Nth occurrence from the beginning of the period, for example NthOccurrence = 1, represents 1st occurrence of the day of the week. Negative values represent Nth occurrence from the end of the period, for example NthOccurrence = -1, represents last occurrence of the day of the week. When NthOccurrence is zero, it represents all occurrences of the specified day of the week. For example, BYDAY=MO has NthOccurrence zero and represents all Mondays in the set.

      • setNthOccurrence

        public void setNthOccurrence(int value)
      • getDayOfWeek

        public int getDayOfWeek()

        Gets or sets the day of the week.

      • setDayOfWeek

        public void setDayOfWeek(int value)
      • isAllOccurrences

        public boolean isAllOccurrences()

        Returns True when NthOccurrence is zero (meaning all occurrences of this day of week).

      • equals

        public boolean equals(ByDay other)