CalendarRecurrence

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.ms.System.IEquatable

public class CalendarRecurrence implements System.IEquatable<CalendarRecurrence>

The main class, represents an iCalendar recurrence.

Constructors

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

Methods

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

CalendarRecurrence()

public CalendarRecurrence()

Initializes a new instance of the CalendarRecurrence class.

CalendarRecurrence(String pattern)

public CalendarRecurrence(String pattern)

Initializes a new instance of the CalendarRecurrence class.

Parameters:

Parameter Type Description
pattern java.lang.String The pattern.

generateOccurrences()

public final DateCollection generateOccurrences()

Generates the occurrences.

Returns: DateCollection - Collection of datesDateCollection.

generateOccurrences(int nNextOccurrences)

public final DateCollection generateOccurrences(int nNextOccurrences)

Generates n next occurrences.

Parameters:

Parameter Type Description
nNextOccurrences int The amount of needed occurrences.

Returns: DateCollection - Collection of datesDateCollection.

generateOccurrences(Date rangeStart, Date rangeEnd)

public final DateCollection generateOccurrences(Date rangeStart, Date rangeEnd)

Generates the occurrences.

Parameters:

Parameter Type Description
rangeStart java.util.Date The range start.
rangeEnd java.util.Date The range end.

Returns: DateCollection - Collection of datesDateCollection.

generateOccurrences(Date rangeStart, Date rangeEnd, int nNextOccurrences)

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

Generates n next occurrences.

Parameters:

Parameter Type Description
rangeStart java.util.Date The range start.
rangeEnd java.util.Date The range end.
nNextOccurrences int The amount of needed occurrences.

Returns: DateCollection - Collection of datesDateCollection.

fromiCalendar(String pattern)

public static CalendarRecurrence fromiCalendar(String pattern)

Gets a recurrence pattern from iCalendar string.

Parameters:

Parameter Type Description
pattern java.lang.String StringString representation of iCalendar.

Returns: CalendarRecurrence - Recurrence patternCalendarRecurrence.

fromRecurrence(String xmlString)

public static CalendarRecurrence fromRecurrence(String xmlString)

Gets a recurrence pattern from XML pattern string.

Parameters:

Parameter Type Description
xmlString java.lang.String XML stringString of pattern.

Returns: CalendarRecurrence - Recurrence patternCalendarRecurrence.

fromRecurrence(System.Xml.XmlElement xmlElement)

public static CalendarRecurrence fromRecurrence(System.Xml.XmlElement xmlElement)

Gets a recurrence pattern from XmlElement.

Parameters:

Parameter Type Description
xmlElement com.aspose.ms.System.Xml.XmlElement XmlElementXmlElement of pattern.

Returns: CalendarRecurrence - Recurrence patternCalendarRecurrence.

toiCalendar()

public final String toiCalendar()

To iCalendar string.

Returns: java.lang.String - StringString representation of RecurrencePattern.

getStartDate()

public final Date getStartDate()

Gets or sets the start date.

Value: The start date.

Returns: java.util.Date

setStartDate(Date value)

public final void setStartDate(Date value)

Gets or sets the start date.

Value: The start date.

Parameters:

Parameter Type Description
value java.util.Date

getEndDate()

public final Date getEndDate()

Gets or sets the end date.

Value: The end date.

Returns: java.util.Date

setEndDate(Date value)

public final void setEndDate(Date value)

Gets or sets the end date.

Value: The end date.

Parameters:

Parameter Type Description
value java.util.Date

getRRules()

public final RecurrenceRuleCollection getRRules()

Gets the R rules.

Value: The R rules.

Returns: RecurrenceRuleCollection

getExRules()

public final RecurrenceRuleCollection getExRules()

Gets the ex rules.

Value: The ex rules.

Returns: RecurrenceRuleCollection

getRDates()

public final DateCollection getRDates()

Gets the R dates.

Value: The R dates.

Returns: DateCollection

getExDates()

public final DateCollection getExDates()

Gets the ex dates.

Value: The ex dates.

Returns: DateCollection

equals(CalendarRecurrence other)

public boolean equals(CalendarRecurrence other)

Determines whether the specified CalendarRecurrence is equal to this instance.

Parameters:

Parameter Type Description
other CalendarRecurrence The CalendarRecurrence to compare with this instance.

Returns: boolean - ``` true ``` if the specified CalendarRecurrence is equal to this instance; otherwise, ``` false ```.

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

Returns a hash code for this instance.

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

op_Equality(CalendarRecurrence left, CalendarRecurrence right)

public static boolean op_Equality(CalendarRecurrence left, CalendarRecurrence right)

Implements the operator ==.

Parameters:

Parameter Type Description
left CalendarRecurrence The left.
right CalendarRecurrence The right.

Returns: boolean - The result of the operator.

op_Inequality(CalendarRecurrence left, CalendarRecurrence right)

public static boolean op_Inequality(CalendarRecurrence left, CalendarRecurrence right)

Implements the operator !=.

Parameters:

Parameter Type Description
left CalendarRecurrence The left.
right CalendarRecurrence The right.

Returns: boolean - The result of the operator.