ByDay

Inheritance: java.lang.Object

public class ByDay

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.

```

Constructors

Constructor Description
ByDay(int dayOfWeek) Initializes a new instance of ByDay class.
ByDay(int nthOccurrence, int dayOfWeek) Initializes a new instance of ByDay class.

Methods

Method Description
getNthOccurrence() Gets or sets the nth occurrence of the day of the week.
setNthOccurrence(int value) Gets or sets the nth occurrence of the day of the week.
getDayOfWeek() Gets or sets the day of the week.
setDayOfWeek(int value) Gets or sets the day of the week.
isAllOccurrences() Returns True when NthOccurrence is zero (meaning all occurrences of this day of week).
equals(Object obj) Determines whether the specified Object is equal to the current Object.
hashCode() GetHashCode returns a hash function for this object.

ByDay(int dayOfWeek)

public ByDay(int dayOfWeek)

Initializes a new instance of ByDay class.

Parameters:

Parameter Type Description
dayOfWeek int A day of the week.

ByDay(int nthOccurrence, int dayOfWeek)

public ByDay(int nthOccurrence, int dayOfWeek)

Initializes a new instance of ByDay class.

Parameters:

Parameter Type Description
nthOccurrence int The nth occurrence of the day of the week.
dayOfWeek int A day of the week.

getNthOccurrence()

public final 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.

```

Returns: int

setNthOccurrence(int value)

public final void setNthOccurrence(int value)

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.

```

Parameters:

Parameter Type Description
value int

getDayOfWeek()

public final int getDayOfWeek()

Gets or sets the day of the week.

Returns: int

setDayOfWeek(int value)

public final void setDayOfWeek(int value)

Gets or sets the day of the week.

Parameters:

Parameter Type Description
value int

isAllOccurrences()

public final boolean isAllOccurrences()

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

Returns: boolean

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.