net.fortuna.ical4j.model.property
Class RRule

java.lang.Object
  extended bynet.fortuna.ical4j.model.Content
      extended bynet.fortuna.ical4j.model.Property
          extended bynet.fortuna.ical4j.model.property.RRule
All Implemented Interfaces:
Serializable

public class RRule
extends Property

Defines an RRULE iCalendar component property.

Author:
benf
See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.fortuna.ical4j.model.Property
ACTION, ATTACH, ATTENDEE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, FREEBUSY, GEO, LAST_MODIFIED, LOCATION, METHOD, ORGANIZER, PERCENT_COMPLETE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, SUMMARY, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION
 
Constructor Summary
RRule()
          Default constructor.
RRule(ParameterList aList, Recur aRecur)
           
RRule(ParameterList aList, String aValue)
           
RRule(Recur aRecur)
           
 
Method Summary
 Recur getRecur()
           
 String getValue()
           
 void setValue(String aValue)
          Sets the current value of the property.
 void validate()
          Perform validation on a property.
 
Methods inherited from class net.fortuna.ical4j.model.Property
equals, getName, getParameter, getParameters, getParameters, hashCode, isCalendarProperty, isComponentProperty, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RRule

public RRule()
Default constructor.


RRule

public RRule(ParameterList aList,
             String aValue)
      throws ParseException
Parameters:
aList - a list of parameters for this component
aValue - a value string for this component
Throws:
ParseException - thrown when the specified string is not a valid representaton of a recurrence
See Also:
Recur.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 component
aRecur - a recurrence value
Method Detail

getRecur

public final Recur getRecur()
Returns:
Returns the recur.

setValue

public final void setValue(String aValue)
                    throws ParseException
Description copied from class: Property
Sets the current value of the property.

Specified by:
setValue in class Property
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()
Specified by:
getValue in class Property
Returns:
Returns the value.

validate

public final void validate()
                    throws ValidationException
Description copied from class: Property
Perform validation on a property.

Specified by:
validate in class Property
Throws:
ValidationException - where the property is not in a valid state