com.aspose.email

Class CalendarRecurrence

java.lang.Object

com.aspose.email.CalendarRecurrence

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<CalendarRecurrence>

public class CalendarRecurrence
extends Object
implements com.aspose.ms.System.IEquatable<CalendarRecurrence>

The main class, represents an iCalendar recurrence.

Constructor Summary

Constructors

Constructor and Description
CalendarRecurrence() Initializes a new instance of the CalendarRecurrence class.
CalendarRecurrence(String pattern) Initializes a new instance of the CalendarRecurrence class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(CalendarRecurrence other) Determines whether the specified CalendarRecurrence is equal to this instance.
boolean	equals(Object obj) Determines whether the specified Object is equal to the current Object.
static CalendarRecurrence	fromiCalendar(String pattern) Gets a recurrence pattern from iCalendar string.
static CalendarRecurrence	fromRecurrence(String xmlString) Gets a recurrence pattern from XML pattern string.
static CalendarRecurrence	fromRecurrence(com.aspose.ms.System.Xml.XmlElement xmlElement) Gets a recurrence pattern from XmlElement.
DateCollection	generateOccurrences() Generates the occurrences.
DateCollection	generateOccurrences(Date rangeStart, Date rangeEnd) Generates the occurrences.
DateCollection	generateOccurrences(Date rangeStart, Date rangeEnd, int nNextOccurrences) Generates n next occurrences.
DateCollection	generateOccurrences(int nNextOccurrences) Generates n next occurrences.
Date	getEndDate() Gets or sets the end date.
DateCollection	getExDates() Gets the ex dates.
RecurrenceRuleCollection	getExRules() Gets the ex rules.
DateCollection	getRDates() Gets the R dates.
RecurrenceRuleCollection	getRRules() Gets the R rules.
Date	getStartDate() Gets or sets the start date.
int	hashCode() Returns a hash code for this instance.
static boolean	op_Equality(CalendarRecurrence left, CalendarRecurrence right) Implements the operator ==.
static boolean	op_Inequality(CalendarRecurrence left, CalendarRecurrence right) Implements the operator !=.
void	setEndDate(Date value) Gets or sets the end date.
void	setStartDate(Date value) Gets or sets the start date.
String	toiCalendar() To iCalendar string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalendarRecurrence

public CalendarRecurrence()

Initializes a new instance of the CalendarRecurrence class.

CalendarRecurrence

public CalendarRecurrence(String pattern)

Initializes a new instance of the CalendarRecurrence class.

Parameters:

pattern - The pattern.

Method Detail

generateOccurrences

public final DateCollection generateOccurrences()

Generates the occurrences.

Returns:

Collection of datesDateCollection.

Throws:

Exception - throws if StartDate is not set.

generateOccurrences

public final DateCollection generateOccurrences(int nNextOccurrences)

Generates n next occurrences.

Parameters:

nNextOccurrences - The amount of needed occurrences.

Returns:

Collection of datesDateCollection.

Throws:

Exception - throws if StartDate is not set.

com.aspose.ms.System.ArgumentOutOfRangeException - throws if amount of needed occurrences is less or equal zero.

generateOccurrences

public final DateCollection generateOccurrences(Date rangeStart,
                                 Date rangeEnd)

Generates the occurrences.

Parameters:

rangeStart - The range start.

rangeEnd - The range end.

Returns:

Collection of datesDateCollection.

Throws:

Exception - throws if StartDate is not set

generateOccurrences

public final DateCollection generateOccurrences(Date rangeStart,
                                 Date rangeEnd,
                                 int nNextOccurrences)

Generates n next occurrences.

Parameters:

rangeStart - The range start.

rangeEnd - The range end.

nNextOccurrences - The amount of needed occurrences.

Returns:

Collection of datesDateCollection.

Throws:

Exception - throws if StartDate is not set.

com.aspose.ms.System.ArgumentOutOfRangeException - throws if amount of needed occurrences is less or equal zero.

fromiCalendar

public static CalendarRecurrence fromiCalendar(String pattern)

Gets a recurrence pattern from iCalendar string.

Parameters:

pattern - StringString representation of iCalendar.

Returns:

Recurrence patternCalendarRecurrence.

fromRecurrence

public static CalendarRecurrence fromRecurrence(String xmlString)

Gets a recurrence pattern from XML pattern string.

Parameters:

xmlString - XML stringString of pattern.

Returns:

Recurrence patternCalendarRecurrence.

fromRecurrence

public static CalendarRecurrence fromRecurrence(com.aspose.ms.System.Xml.XmlElement xmlElement)

Gets a recurrence pattern from XmlElement.

Parameters:

xmlElement - XmlElementXmlElement of pattern.

Returns:

Recurrence patternCalendarRecurrence.

toiCalendar

public final String toiCalendar()

To iCalendar string.

Returns:

StringString representation of RecurrencePattern.

getStartDate

public final Date getStartDate()

Gets or sets the start date.

Value: The start date.

setStartDate

public final void setStartDate(Date value)

Gets or sets the start date.

Value: The start date.

getEndDate

public final Date getEndDate()

Gets or sets the end date.

Value: The end date.

setEndDate

public final void setEndDate(Date value)

Gets or sets the end date.

Value: The end date.

getRRules

public final RecurrenceRuleCollection getRRules()

Gets the R rules.

Value: The R rules.

getExRules

public final RecurrenceRuleCollection getExRules()

Gets the ex rules.

Value: The ex rules.

getRDates

public final DateCollection getRDates()

Gets the R dates.

Value: The R dates.

getExDates

public final DateCollection getExDates()

Gets the ex dates.

Value: The ex dates.

equals

public boolean equals(CalendarRecurrence other)

Determines whether the specified CalendarRecurrence is equal to this instance.

Parameters:

other - The CalendarRecurrence to compare with this instance.

Returns:

true if the specified CalendarRecurrence is equal to this instance; otherwise, false.

equals

public boolean equals(Object obj)

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

Specified by:

equals in interface com.aspose.ms.System.IEquatable<CalendarRecurrence>

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()

Returns a hash code for this instance.

Overrides:

hashCode in class Object

Returns:

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

op_Equality

public static boolean op_Equality(CalendarRecurrence left,
                  CalendarRecurrence right)

Implements the operator ==.

Parameters:

left - The left.

right - The right.

Returns:

The result of the operator.

op_Inequality

public static boolean op_Inequality(CalendarRecurrence left,
                    CalendarRecurrence right)

Implements the operator !=.

Parameters:

left - The left.

right - The right.

Returns:

The result of the operator.