Module ical4j.core

Package net.fortuna.ical4j.model.property

Class RRule<T extends Temporal>

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.RRule<T>

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty, Prototype<Property>

public class RRule<T extends Temporal>
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<T extends Temporal>

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
RRule()	Default constructor.
RRule(String value)
RRule(ParameterList aList, String aValue)
RRule(ParameterList aList, Recur<T> aRecur)
RRule(Recur<T> aRecur)
RRule(Frequency frequency)

Method Summary

Modifier and Type	Method	Description
final Recur<T>	getRecur()
final String	getValue()
protected PropertyFactory<RRule<T>>	newFactory()	Returns a new property factory used to create deep copies.
void	setRecur(Recur<T> recur)
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

add, compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameter, getParameterList, getParameters, getPrefix, getRequiredParameter, getRequiredParameter, hashCode, remove, removeAll, replace, setParameters, setPrefix, 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

RRule

public RRule()

Default constructor.

RRule

public RRule(Frequency frequency)

RRule

public RRule(String value)

Parameters:

value - a rule string

RRule

public RRule(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

See Also:

• Recur(String)

RRule

public RRule(Recur<T> aRecur)

Parameters:

aRecur - a recurrence value

RRule

public RRule(ParameterList aList,
 Recur<T> aRecur)

Parameters:

aList - a list of parameters for this component

aRecur - a recurrence value

Method Details

getRecur

public final Recur<T> getRecur()

Returns:

Returns the recur.

setRecur

public void setRecur(Recur<T> recur)

setValue

public void setValue(String aValue)

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

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

newFactory

protected PropertyFactory<RRule<T>> newFactory()

Description copied from class: Property

Returns a new property factory used to create deep copies.

Specified by:

newFactory in class Property

Returns:

a property factory instance