Top Fields Constructors Methods
net.fortuna.ical4j.model.property.immutable

public final Class ImmutableAction

extends Action
implements ImmutableProperty
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.property.ImmutableProperty
Imports
net.fortuna.ical4j.model.Parameter, .Property, net.fortuna.ical4j.model.property.Action, .ImmutableProperty

Author
Ben Fortuna An immutable instance of Action.

Field Summary

Modifier and TypeField and Description
public static final Action
AUDIO

Constant actions for playing an audible sound.

public static final Action
DISPLAY

Constant action for displaying a visible notification.

public static final Action
EMAIL

Constant action for sending an email.

public static final Action
PROCEDURE

Constant action for a procedure.

private static final long
Inherited from net.fortuna.ical4j.model.property.Action:
VALUE_AUDIOVALUE_DISPLAYVALUE_EMAILVALUE_PROCEDURE

Constructor Summary

AccessConstructor and Description
public
ImmutableAction(final String value)

Method Summary

Modifier and TypeMethod and Description
public <T extends Property> T
add(Parameter
the parameter to add
parameter
)

Overrides net.fortuna.ical4j.model.Property.add.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.add.

Add a parameter to the property's parameter list.

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

Overrides net.fortuna.ical4j.model.Property.remove.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.remove.

Remove a parameter from the property's parameter list.

public <T extends Property> T
removeAll(String...
the name of parameters to remove
parameterName
)

Overrides net.fortuna.ical4j.model.Property.removeAll.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.removeAll.

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

public <T extends Property> T
replace(Parameter
the parameter to add
parameter
)

Overrides net.fortuna.ical4j.model.Property.replace.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.replace.

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

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

Overrides net.fortuna.ical4j.model.property.Action.setValue.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.setValue.

Sets the current value of the property.

Inherited from net.fortuna.ical4j.model.property.Action:
getValuenewFactoryvalidate

Field Detail

AUDIOback to summary
public static final Action AUDIO

Constant actions for playing an audible sound.

DISPLAYback to summary
public static final Action DISPLAY

Constant action for displaying a visible notification.

EMAILback to summary
public static final Action EMAIL

Constant action for sending an email.

PROCEDUREback to summary
public static final Action PROCEDURE

Constant action for a procedure.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.property.Action.serialVersionUID.

Constructor Detail

ImmutableActionback to summary
public ImmutableAction(final String value)

Method Detail

addback to summary
public <T extends Property> T add(Parameter parameter)

Overrides net.fortuna.ical4j.model.Property.add.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.add.

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

Add a parameter to the property's parameter list.

Parameters
parameter:Parameter

the parameter to add

Returns:T

a reference to the property to support method chaining

Annotations
@Override
removeback to summary
public <T extends Property> T remove(Parameter parameter)

Overrides net.fortuna.ical4j.model.Property.remove.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.remove.

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

Remove a parameter from the property's parameter list.

Parameters
parameter:Parameter

the parameter to remove

Returns:T

a reference to the property to support method chaining

Annotations
@Override
removeAllback to summary
public <T extends Property> T removeAll(String... parameterName)

Overrides net.fortuna.ical4j.model.Property.removeAll.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.removeAll.

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

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

Parameters
parameterName:String[]

the name of parameters to remove

Returns:T

a reference to the property to support method chaining

Annotations
@Override
replaceback to summary
public <T extends Property> T replace(Parameter parameter)

Overrides net.fortuna.ical4j.model.Property.replace.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.replace.

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

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

Parameters
parameter:Parameter

the parameter to add

Returns:T

a reference to the property to support method chaining

Annotations
@Override
setValueback to summary
public void setValue(final String aValue)

Overrides net.fortuna.ical4j.model.property.Action.setValue.

Overrides default net.fortuna.ical4j.model.property.ImmutableProperty.setValue.

Doc from net.fortuna.ical4j.model.property.Action.setValue.

Sets the current value of the property.

Parameters
aValue:String

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

a string representation of the property value

Annotations
@Override