Package 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:

Serializable, Comparable<Property>, FluentProperty

public class ExRule
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a EXRULE iCalendar component property.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExRule.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, XML

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Recur	getRecur()
final String	getValue()
final void	setRecur(Recur recur)
final 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, getFluentTarget, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Details

ExRule

public ExRule()

Default constructor.

ExRule

public ExRule(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(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 Details

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 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 Content

Returns:

the content value

setRecur

public final void setRecur(Recur recur)

Parameters:

recur - The recur to set.

validate

public ValidationResult 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