Class RRule
- java.lang.Object
-
- net.fortuna.ical4j.model.Content
-
- net.fortuna.ical4j.model.Property
-
- net.fortuna.ical4j.model.property.RRule
-
- All Implemented Interfaces:
Serializable
,Comparable<Property>
public class RRule extends Property
$Id$ Created: [Apr 6, 2004] Defines an RRULE iCalendar component property.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RRule.Factory
-
Field Summary
-
Fields inherited from class net.fortuna.ical4j.model.Property
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Recur
getRecur()
String
getValue()
void
setValue(String aValue)
Sets the current value of the property.ValidationResult
validate()
Perform validation on a property.-
Methods inherited from class net.fortuna.ical4j.model.Property
compareTo, copy, equals, getName, getParameter, getParameters, getParameters, hashCode, toString
-
-
-
-
Constructor Detail
-
RRule
public RRule()
Default constructor.
-
RRule
public RRule(String value) throws ParseException
- Parameters:
value
- a rule string- Throws:
ParseException
- where the if the UNTIL part of the recurrence string is an invalid date representationIllegalArgumentException
- where the recurrence string contains an unrecognised token
-
RRule
public RRule(ParameterList aList, String aValue) throws ParseException
- Parameters:
aList
- a list of parameters for this componentaValue
- a value string for this component- Throws:
ParseException
- thrown when the specified string is not a valid representaton of a recurrence- See Also:
Recur(String)
-
RRule
public RRule(Recur aRecur)
- Parameters:
aRecur
- a recurrence value
-
RRule
public RRule(ParameterList aList, Recur aRecur)
- Parameters:
aList
- a list of parameters for this componentaRecur
- a recurrence value
-
-
Method Detail
-
getRecur
public final Recur getRecur()
- Returns:
- Returns the recur.
-
setValue
public final void setValue(String aValue) throws ParseException
Sets the current value of the property.- Specified by:
setValue
in classProperty
- Parameters:
aValue
- a string representation of the property value- Throws:
ParseException
- possibly thrown by setting the value of certain properties
-
getValue
public final String getValue()
-
validate
public ValidationResult validate() throws ValidationException
Description copied from class:Property
Perform validation on a property.- Specified by:
validate
in classProperty
- Throws:
ValidationException
- where the property is not in a valid state
-
-