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
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.
fromRecurrence(String xmlString)	Gets a recurrence pattern from XML pattern string.
fromRecurrence(Element xmlElement)	Gets a recurrence pattern from XmlElement.
fromiCalendar(String pattern)	Gets a recurrence pattern from iCalendar string.
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.
getClass()
getEndDate()	Gets or sets the end date.
getExDates()	Gets the ex dates.
getExRules()	Gets the ex rules.
getRDates()	Gets the R dates.
getRRules()	Gets the R rules.
getStartDate()	Gets or sets the start date.
hashCode()	Returns a hash code for this instance.
notify()
notifyAll()
op_Equality(CalendarRecurrence left, CalendarRecurrence right)	Implements the operator ==.
op_Inequality(CalendarRecurrence left, CalendarRecurrence right)	Implements the operator !=.
setEndDate(Date value)	Gets or sets the end date.
setStartDate(Date value)	Gets or sets the start date.
toString()
toiCalendar()	To iCalendar string.
wait()
wait(long arg0)
wait(long arg0, int arg1)

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.

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.

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

public static CalendarRecurrence fromRecurrence(Element xmlElement)

Gets a recurrence pattern from XmlElement.

Parameters:

Parameter	Type	Description
xmlElement	org.w3c.dom.Element	XmlElementXmlElement of pattern.

Returns: CalendarRecurrence - Recurrence patternCalendarRecurrence.

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.

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.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getEndDate()

public final Date getEndDate()

Gets or sets the end date.

Value: The end date.

Returns: java.util.Date

getExDates()

public final DateCollection getExDates()

Gets the ex dates.

Value: The ex dates.

Returns: DateCollection

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

getRRules()

public final RecurrenceRuleCollection getRRules()

Gets the R rules.

Value: The R rules.

Returns: RecurrenceRuleCollection

getStartDate()

public final Date getStartDate()

Gets or sets the start date.

Value: The start date.

Returns: java.util.Date

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.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

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.

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

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

toString()

public String toString()

Returns: java.lang.String

toiCalendar()

public final String toiCalendar()

To iCalendar string.

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

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int