Module ical4j.core

Package net.fortuna.ical4j.model.property.immutable

Class ImmutableAction

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Action

net.fortuna.ical4j.model.property.immutable.ImmutableAction

All Implemented Interfaces:

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

public final class ImmutableAction
extends Action
implements ImmutableProperty

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.fortuna.ical4j.model.property.Action

Action.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final Action	AUDIO	Constant actions for playing an audible sound.
static final Action	DISPLAY	Constant action for displaying a visible notification.
static final Action	EMAIL	Constant action for sending an email.
static final Action	PROCEDURE	Constant action for a procedure.

Fields inherited from class net.fortuna.ical4j.model.property.Action

VALUE_AUDIO, VALUE_DISPLAY, VALUE_EMAIL, VALUE_PROCEDURE

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
ImmutableAction(String value)

Method Summary

Modifier and Type	Method	Description
<T extends Property> T	add(Parameter parameter)	Add a parameter to the property's parameter list.
<T extends Property> T	remove(Parameter parameter)	Remove a parameter from the property's parameter list.
<T extends Property> T	removeAll(String... parameterName)	Remove all parameters with the specified name from the property's parameter list.
<T extends Property> T	replace(Parameter parameter)	Add a parameter to the property's parameter list whilst removing all other parameters with the same name.
void	setValue(String aValue)	Sets the current value of the property.

Methods inherited from class net.fortuna.ical4j.model.property.Action

getValue, newFactory, validate

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

compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameter, getParameterList, getParameters, getPrefix, getRequiredParameter, getRequiredParameter, hashCode, 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

Methods inherited from interface net.fortuna.ical4j.model.property.ImmutableProperty

throwException

Field Details

AUDIO

public static final Action AUDIO

Constant actions for playing an audible sound.

DISPLAY

public static final Action DISPLAY

Constant action for displaying a visible notification.

EMAIL

public static final Action EMAIL

Constant action for sending an email.

PROCEDURE

public static final Action PROCEDURE

Constant action for a procedure.

Constructor Details

ImmutableAction

public ImmutableAction(String value)

Parameters:

value -

Method Details

add

public <T extends Property> T add(Parameter parameter)

Description copied from class: Property

Add a parameter to the property's parameter list.

Specified by:

add in interface ImmutableProperty

Overrides:

add in class Property

Parameters:

parameter - the parameter to add

Returns:

a reference to the property to support method chaining

remove

public <T extends Property> T remove(Parameter parameter)

Description copied from class: Property

Remove a parameter from the property's parameter list.

Specified by:

remove in interface ImmutableProperty

Overrides:

remove in class Property

Parameters:

parameter - the parameter to remove

Returns:

a reference to the property to support method chaining

removeAll

public <T extends Property> T removeAll(String... parameterName)

Description copied from class: Property

Remove all parameters with the specified name from the property's parameter list.

Specified by:

removeAll in interface ImmutableProperty

Overrides:

removeAll in class Property

Parameters:

parameterName - the name of parameters to remove

Returns:

a reference to the property to support method chaining

replace

public <T extends Property> T replace(Parameter parameter)

Description copied from class: Property

Add a parameter to the property's parameter list whilst removing all other parameters with the same name.

Specified by:

replace in interface ImmutableProperty

Overrides:

replace in class Property

Parameters:

parameter - the parameter to add

Returns:

a reference to the property to support method chaining

setValue

public void setValue(String aValue)

Description copied from class: Action

Sets the current value of the property.

Specified by:

setValue in interface ImmutableProperty

Overrides:

setValue in class Action

Parameters:

aValue - a string representation of the property value