Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class RRule<T extends Temporal>

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.transform.recurrence.Frequency, net.fortuna.ical4j.validate.RecurValidator, .ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.RecurrencePropertyValidators, java.time.temporal.Temporal
$Id$

Created: [Apr 6, 2004]

Defines an RRULE iCalendar component property.

Author
benf

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
RRule.Factory<T extends Temporal>

Field Summary

Modifier and TypeField and Description
private Recur<T>
recur

private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
RRule()

Default constructor.

public
RRule(Frequency frequency)

public
RRule(String
a rule string
value)

public
RRule(final ParameterList
a list of parameters for this component
aList, final String
a value string for this component
aValue)

public
RRule(final Recur<T>
a recurrence value
aRecur)

public
RRule(final ParameterList
a list of parameters for this component
aList, final Recur<T>
a recurrence value
aRecur)

Method Summary

Modifier and TypeMethod and Description
public final Recur<T>

Returns:

Returns the recur.
getRecur()

public final String
getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

protected PropertyFactory<RRule<T>>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public void
setRecur(Recur<T> recur)

public void
setValue(final String
a string representation of the property value
aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

recurback to summary
private Recur<T> recur
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

RRuleback to summary
public RRule()

Default constructor.

RRuleback to summary
public RRule(Frequency frequency)
RRuleback to summary
public RRule(String value)
Parameters
value:String

a rule string

RRuleback to summary
public RRule(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

See Also
Recur#Recur(String)
RRuleback to summary
public RRule(final Recur<T> aRecur)
Parameters
aRecur:Recur<T>

a recurrence value

RRuleback to summary
public RRule(final ParameterList aList, final Recur<T> aRecur)
Parameters
aList:ParameterList

a list of parameters for this component

aRecur:Recur<T>

a recurrence value

Method Detail

getRecurback to summary
public final Recur<T> getRecur()
Returns:Recur<T>

Returns the recur.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<RRule<T>> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<RRule<T>>

a property factory instance

Annotations
@Override
setRecurback to summary
public void setRecur(Recur<T> recur)
setValueback to summary
public void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class RRule.Factory<T extends Temporal>

extends Factory
implements PropertyFactory<RRule<T extends Temporal>>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public RRule<T>
createProperty(final ParameterList
a list of property parameters
parameters, final String
a property value
value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public RRule<T>
createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public RRule<T> createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:RRule<T>

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public RRule<T> createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:RRule<T>

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override