public class RecurrencePattern extends Object
The main class, represents a recurrence pattern.
Constructor and Description |
---|
RecurrencePattern()
Initializes a new instance of the
RecurrencePattern class. |
RecurrencePattern(String pattern)
Initializes a new instance of the
RecurrencePattern class. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Determines whether the specified Object is equal to the current Object.
|
boolean |
equals(RecurrencePattern other)
Determines whether the specified
Aspose.iCalendar.RecurrencePattern is equal to this instance. |
static RecurrencePattern |
fromiCalendar(String pattern)
Gets a recurrence pattern from iCalendar string.
|
static RecurrencePattern |
fromRecurrence(String recurrenceXMLstring)
Gets a recurrence pattern from XML pattern string.
|
static RecurrencePattern |
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(RecurrencePattern left,
RecurrencePattern right)
Implements the operator ==.
|
static boolean |
op_Inequality(RecurrencePattern left,
RecurrencePattern 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.
|
public RecurrencePattern()
Initializes a new instance of the RecurrencePattern
class.
public RecurrencePattern(String pattern)
Initializes a new instance of the RecurrencePattern
class.
pattern
- The pattern.public DateCollection generateOccurrences()
Generates the occurrences.
Aspose.iCalendar.DateCollection
.com.aspose.ms.System.Exception
- throws if StartDate is not set.public DateCollection generateOccurrences(int nNextOccurrences)
Generates n next occurrences.
nNextOccurrences
- The amount of needed occurrences.Aspose.iCalendar.DateCollection
.com.aspose.ms.System.Exception
- throws if StartDate is not set.com.aspose.ms.System.ArgumentOutOfRangeException
- throws if amount of needed occurrences is less or equal zero.public DateCollection generateOccurrences(Date rangeStart, Date rangeEnd)
Generates the occurrences.
rangeStart
- The range start.rangeEnd
- The range end.Aspose.iCalendar.DateCollection
.com.aspose.ms.System.Exception
- throws if StartDate is not setpublic DateCollection generateOccurrences(Date rangeStart, Date rangeEnd, int nNextOccurrences)
Generates n next occurrences.
rangeStart
- The range start.rangeEnd
- The range end.nNextOccurrences
- The amount of needed occurrences.Aspose.iCalendar.DateCollection
.com.aspose.ms.System.Exception
- throws if StartDate is not set.com.aspose.ms.System.ArgumentOutOfRangeException
- throws if amount of needed occurrences is less or equal zero.public static RecurrencePattern fromiCalendar(String pattern)
Gets a recurrence pattern from iCalendar string.
pattern
- StringSystem.String
representation of iCalendar.Aspose.iCalendar.RecurrencePattern
.public static RecurrencePattern fromRecurrence(String recurrenceXMLstring)
Gets a recurrence pattern from XML pattern string.
recurrenceXMLstring
- XML stringSystem.String
of pattern.Aspose.iCalendar.RecurrencePattern
.public static RecurrencePattern fromRecurrence(com.aspose.ms.System.Xml.XmlElement xmlElement)
Gets a recurrence pattern from XmlElement.
xmlElement
- XmlElementSystem.Xml.XmlElement
of pattern.Aspose.iCalendar.RecurrencePattern
.public String toiCalendar()
To iCalendar string.
System.String
representation of RecurrencePattern.public Date getStartDate()
Gets or sets the start date.
Value: The start date.Date
object.public void setStartDate(Date value)
Gets or sets the start date.
Value: The start date.value
- a Date
object.public Date getEndDate()
Gets or sets the end date.
Value: The end date.Date
object.public void setEndDate(Date value)
Gets or sets the end date.
Value: The end date.value
- a Date
object.public RecurrenceRuleCollection getRRules()
Gets the R rules.
Value: The R rules.RecurrenceRuleCollection
object.public RecurrenceRuleCollection getExRules()
Gets the ex rules.
Value: The ex rules.RecurrenceRuleCollection
object.public DateCollection getRDates()
Gets the R dates.
Value: The R dates.DateCollection
object.public DateCollection getExDates()
Gets the ex dates.
Value: The ex dates.DateCollection
object.public boolean equals(RecurrencePattern other)
Determines whether the specified Aspose.iCalendar.RecurrencePattern
is equal to this instance.
other
- The Aspose.iCalendar.RecurrencePattern
to compare with this instance.true
if the specified Aspose.iCalendar.RecurrencePattern
is equal to this instance; otherwise, false
.public boolean equals(Object obj)
Determines whether the specified Object is equal to the current Object.
public int hashCode()
Returns a hash code for this instance.
public static boolean op_Equality(RecurrencePattern left, RecurrencePattern right)
Implements the operator ==.
left
- The left.right
- The right.public static boolean op_Inequality(RecurrencePattern left, RecurrencePattern right)
Implements the operator !=.
left
- The left.right
- The right.Copyright (c) 2008-2015 Aspose Pty Ltd. All Rights Reserved.