net.fortuna.ical4j.model.property

Class ExRule

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.ExRule

All Implemented Interfaces:

java.io.Serializable

public class ExRule
extends Property

$Id$ Created: [Apr 6, 2004] Defines a EXRULE iCalendar component property.

See Also:

Serialized Form

Property Summary

Properties inherited from class net.fortuna.ical4j.model.Property

isCalendarProperty

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACTION, ATTACH, ATTENDEE, BUSYTYPE, 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, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION

Constructor Summary

Constructors

Constructor and Description
ExRule() Default constructor.
ExRule(ParameterList aList, Recur aRecur)
ExRule(ParameterList aList, java.lang.String aValue)
ExRule(Recur aRecur)

Method Summary

Methods

Modifier and Type	Method and Description
Recur	getRecur()
java.lang.String	getValue()
void	setRecur(Recur recur)
void	setValue(java.lang.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

copy, equals, getName, getParameter, getParameters, getParameters, hashCode, isCalendarProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExRule

public ExRule()

Default constructor.

ExRule

public ExRule(ParameterList aList,
      java.lang.String aValue)
       throws java.text.ParseException

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Throws:

java.text.ParseException - thrown when the specified string is not a valid representaton of a recurrence

See Also:

Recur.Recur(String)

ExRule

public ExRule(Recur aRecur)

Parameters:

aRecur - a recurrence

ExRule

public ExRule(ParameterList aList,
      Recur aRecur)

Parameters:

aList - a list of parameters for this component

aRecur - a recurrence

Method Detail

getRecur

public final Recur getRecur()

Returns:

Returns the recur.

setValue

public final void setValue(java.lang.String aValue)
                    throws java.text.ParseException

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

Throws:

java.text.ParseException - possibly thrown by setting the value of certain properties

getValue

public final java.lang.String getValue()

Specified by:

getValue in class Content

Returns:

the content value

setRecur

public final void setRecur(Recur recur)

Parameters:

recur - The recur to set.

validate

public final void validate()
                    throws ValidationException

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state