com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class ByDayCollection

  • java.lang.Object
    • com.aspose.ms.System.Collections.ObjectModel.Collection<ByDay>
      • com.aspose.email.ByDayCollection
  • All Implemented Interfaces:
    com.aspose.ms.System.Collections.Generic.IGenericCollection<ByDay>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ByDay>, com.aspose.ms.System.Collections.Generic.IGenericList<ByDay>, com.aspose.ms.System.Collections.IEnumerable<ByDay>, Iterable<ByDay>

    public class ByDayCollection
extends com.aspose.ms.System.Collections.ObjectModel.Collection<ByDay>

    Represents a collection of ByDay objects.

    <p>Corresponds to the BYDAY part of the recurrence rule.</p> <p>The BYDAY rule specifies a list of days of the week for a monthly or yearly recurrence rule.</p> <p>For each day of the week, a specific Nth occurrence or all occurrences can be specified.</p>

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int add(ByDay byDay)
      Adds a ByDay to the collection.
      int add(int dayOfWeek)
      Creates and adds a ByDay that represents all occurrences of the day of the week to the collection.
      int add(int nthOccurrence, int dayOfWeek)
      Creates and adds a ByDay to the collection.
      boolean contains(int dayOfWeek)
      Returns a value indicating whether a specified day of week is present in the collection.
      boolean equals(ByDayCollection other)
      Determines whether the specified ByDayCollection is equal to this instance.
      boolean equals(Object obj)
      Determines whether the specified Object is equal to the current Object.
      ByDay get(int index)
      Gets or sets a ByDay from the collection.
      int hashCode()
      GetHashCode returns a hash function for this object.
      void set(int index, ByDay value)
      Gets or sets a ByDay from the collection.

      • Methods inherited from class com.aspose.ms.System.Collections.ObjectModel.Collection

        addItem, clear, containsItem, copyToTArray, get_Item, get_Items, getICollection, getIList, getSyncRoot, indexOfItem, insertItem, isReadOnly, iterator, removeAt, removeItem, set_Item, setItem, size

    • Method Detail

      • add

        public final int add(ByDay byDay)

        Adds a ByDay to the collection.

        Parameters:
        byDay - The item to add to the collection.
        Returns:
        The zero-based index of the newly added item.

      • add

        public final int add(int dayOfWeek)

        Creates and adds a ByDay that represents all occurrences of the day of the week to the collection.

        Parameters:
        dayOfWeek - A day of the week.
        Returns:
        The zero-based index of the newly added item.

      • add

        public final int add(int nthOccurrence,
      int dayOfWeek)

        Creates and adds a ByDay to the collection.

        Parameters:
        nthOccurrence - The nth occurrence of the day of the week.
        dayOfWeek - A day of the week.
        Returns:
        The zero-based index of the newly added item.

      • get

        public ByDay get(int index)

        Gets or sets a ByDay from the collection.

        Parameters:
        index - a int.
        Returns:
        a ByDay object.

      • set

        public void set(int index,
       ByDay value)

        Gets or sets a ByDay from the collection.

        Parameters:
        index - a int.
        value - a ByDay object.

      • contains

        public final boolean contains(int dayOfWeek)

        Returns a value indicating whether a specified day of week is present in the collection.

        Parameters:
        dayOfWeek - Day of weekDayOfWeek.
        Returns:
        True if the value parameter exists within this collection, 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.