michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines a METHOD iCalendar property.
michael@0:  * @author benf
michael@0:  */
michael@0: public class Method extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = 7220956532685378719L;
michael@0: 
michael@0:     /**
michael@0:      * Used to publish a calendar entry to one or more Calendar Users. There is no interactivity between the publisher
michael@0:      * and any other calendar user. An example might include a baseball team publishing its schedule to the public. [RFC
michael@0:      * 2446]
michael@0:      */
michael@0:     public static final Method PUBLISH = new ImmutableMethod("PUBLISH");
michael@0: 
michael@0:     /**
michael@0:      * Used to schedule a calendar entry with other Calendar Users. Requests are interactive in that they require the
michael@0:      * receiver to respond using the Reply methods. Meeting Requests, Busy Time requests and the assignment of VTODOs to
michael@0:      * other Calendar Users are all examples. Requests are also used by the "Organizer" to update the status of a
michael@0:      * calendar entry. [RFC 2446]
michael@0:      */
michael@0:     public static final Method REQUEST = new ImmutableMethod("REQUEST");
michael@0: 
michael@0:     /**
michael@0:      * A Reply is used in response to a Request to convey "Attendee" status to the "Organizer". Replies are commonly
michael@0:      * used to respond to meeting and task requests. [RFC2446]
michael@0:      */
michael@0:     public static final Method REPLY = new ImmutableMethod("REPLY");
michael@0: 
michael@0:     /**
michael@0:      * Add one or more instances to an existing VEVENT, VTODO, or VJOURNAL. [RFC 2446]
michael@0:      */
michael@0:     public static final Method ADD = new ImmutableMethod("ADD");
michael@0: 
michael@0:     /**
michael@0:      * Cancel one or more instances of an existing VEVENT, VTODO, or VJOURNAL. [RFC 2446]
michael@0:      */
michael@0:     public static final Method CANCEL = new ImmutableMethod("CANCEL");
michael@0: 
michael@0:     /**
michael@0:      * The Refresh method is used by an "Attendee" to request the latest version of a calendar entry. [RFC 2446]
michael@0:      */
michael@0:     public static final Method REFRESH = new ImmutableMethod("REFRESH");
michael@0: 
michael@0:     /**
michael@0:      * The Counter method is used by an "Attendee" to negotiate a change in the calendar entry. Examples include the
michael@0:      * request to change a proposed Event time or change the due date for a VTODO. [RFC 2446]
michael@0:      */
michael@0:     public static final Method COUNTER = new ImmutableMethod("COUNTER");
michael@0: 
michael@0:     /**
michael@0:      * Used by the "Organizer" to decline the proposed counter-proprosal. [RFC 2446]
michael@0:      */
michael@0:     public static final Method DECLINE_COUNTER = new ImmutableMethod(
michael@0:             "DECLINE-COUNTER");
michael@0: 
michael@0:     /**
michael@0:      * @author Ben Fortuna An immutable instance of Method.
michael@0:      */
michael@0:     private static final class ImmutableMethod extends Method {
michael@0: 
michael@0:         private static final long serialVersionUID = 5332607957381969713L;
michael@0: 
michael@0:         private ImmutableMethod(final String value) {
michael@0:             super(new ParameterList(true), value);
michael@0:         }
michael@0: 
michael@0:         public void setValue(final String aValue) {
michael@0:             throw new UnsupportedOperationException(
michael@0:                     "Cannot modify constant instances");
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     private String value;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public Method() {
michael@0:         super(METHOD, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Method(final String aValue) {
michael@0:         super(METHOD, PropertyFactoryImpl.getInstance());
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Method(final ParameterList aList, final String aValue) {
michael@0:         super(METHOD, aList, PropertyFactoryImpl.getInstance());
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public void setValue(final String aValue) {
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         return value;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0:         // TODO: Auto-generated method stub
michael@0:     }
michael@0: }