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

Class ImmutableMethod

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Method

net.fortuna.ical4j.model.property.immutable.ImmutableMethod

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty, ImmutableProperty

public final class ImmutableMethod
extends Method
implements ImmutableProperty

See Also:

Serialized Form

Nested Class Summary

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

Method.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static Method	ADD	Add one or more instances to an existing VEVENT, VTODO, or VJOURNAL.
static Method	CANCEL	Cancel one or more instances of an existing VEVENT, VTODO, or VJOURNAL.
static Method	COUNTER	The Counter method is used by an "Attendee" to negotiate a change in the calendar entry.
static Method	DECLINE_COUNTER	Used by the "Organizer" to decline the proposed counter-proprosal.
static Method	PUBLISH	Used to publish a calendar entry to one or more Calendar Users.
static Method	REFRESH	The Refresh method is used by an "Attendee" to request the latest version of a calendar entry.
static Method	REPLY	A Reply is used in response to a Request to convey "Attendee" status to the "Organizer".
static Method	REQUEST	Used to schedule a calendar entry with other Calendar Users.

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

VALUE_ADD, VALUE_CANCEL, VALUE_COUNTER, VALUE_DECLINECOUNTER, VALUE_PUBLISH, VALUE_REFRESH, VALUE_REPLY, VALUE_REQUEST

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

Constructor Summary

Constructors

Constructor	Description
ImmutableMethod(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.Method

getValue, newFactory, validate

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

compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameterList, getParameters, getRequiredParameter, hashCode, setParameters, 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.immutable.ImmutableProperty

throwException

Field Detail

PUBLISH

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]

REQUEST

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]

REPLY

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]

ADD

public static final Method ADD

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

CANCEL

public static final Method CANCEL

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

REFRESH

public static final Method REFRESH

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

COUNTER

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_COUNTER

public static final Method DECLINE_COUNTER

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

Constructor Detail

ImmutableMethod

public ImmutableMethod(String value)

Method Detail

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: Method

Sets the current value of the property.

Specified by:

setValue in interface ImmutableProperty

Overrides:

setValue in class Method

Parameters:

aValue - a string representation of the property value