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

public final Class ImmutableMethod

extends Method
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.ImmutableProperty, .Method
Author
Ben Fortuna An immutable instance of Method.

Field Summary

Modifier and TypeField and Description
public static final Method
ADD

Add one or more instances to an existing VEVENT, VTODO, or VJOURNAL.

public static final Method
CANCEL

Cancel one or more instances of an existing VEVENT, VTODO, or VJOURNAL.

public static final Method
COUNTER

The Counter method is used by an "Attendee" to negotiate a change in the calendar entry.

public static final Method
DECLINE_COUNTER

Used by the "Organizer" to decline the proposed counter-proprosal.

public static final Method
PUBLISH

Used to publish a calendar entry to one or more Calendar Users.

public static final Method
REFRESH

The Refresh method is used by an "Attendee" to request the latest version of a calendar entry.

public static final Method
REPLY

A Reply is used in response to a Request to convey "Attendee" status to the "Organizer".

public static final Method
REQUEST

Used to schedule a calendar entry with other Calendar Users.

private static final long
serialVersionUID

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

Inherited from net.fortuna.ical4j.model.property.Method:
VALUE_ADDVALUE_CANCELVALUE_COUNTERVALUE_DECLINECOUNTERVALUE_PUBLISHVALUE_REFRESHVALUE_REPLYVALUE_REQUEST

Constructor Summary

AccessConstructor and Description
public
ImmutableMethod(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.Method.setValue.

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

Sets the current value of the property.

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

Field Detail

ADDback to summary
public static final Method ADD

Add one or more instances to an existing VEVENT, VTODO, or VJOURNAL. [RFC 2446]

CANCELback to summary
public static final Method CANCEL

Cancel one or more instances of an existing VEVENT, VTODO, or VJOURNAL. [RFC 2446]

COUNTERback to summary
public static final Method COUNTER

The Counter method is used by an "Attendee" to negotiate a change in the calendar entry. Examples include the request to change a proposed Event time or change the due date for a VTODO. [RFC 2446]

DECLINE_COUNTERback to summary
public static final Method DECLINE_COUNTER

Used by the "Organizer" to decline the proposed counter-proprosal. [RFC 2446]

PUBLISHback to summary
public static final Method PUBLISH

Used to publish a calendar entry to one or more Calendar Users. There is no interactivity between the publisher and any other calendar user. An example might include a baseball team publishing its schedule to the public. [RFC 2446]

REFRESHback to summary
public static final Method REFRESH

The Refresh method is used by an "Attendee" to request the latest version of a calendar entry. [RFC 2446]

REPLYback to summary
public static final Method REPLY

A Reply is used in response to a Request to convey "Attendee" status to the "Organizer". Replies are commonly used to respond to meeting and task requests. [RFC2446]

REQUESTback to summary
public static final Method REQUEST

Used to schedule a calendar entry with other Calendar Users. Requests are interactive in that they require the receiver to respond using the Reply methods. Meeting Requests, Busy Time requests and the assignment of VTODOs to other Calendar Users are all examples. Requests are also used by the "Organizer" to update the status of a calendar entry. [RFC 2446]

serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

ImmutableMethodback to summary
public ImmutableMethod(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.Method.setValue.

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

Doc from net.fortuna.ical4j.model.property.Method.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