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 STATUS iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.1.11 Status
michael@0:  *     
michael@0:  *        Property Name: STATUS
michael@0:  *     
michael@0:  *        Purpose: This property defines the overall status or confirmation for
michael@0:  *        the calendar component.
michael@0:  *     
michael@0:  *        Value Type: TEXT
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard property parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Conformance: This property can be specified in &quot;VEVENT&quot;, &quot;VTODO&quot; or
michael@0:  *        &quot;VJOURNAL&quot; calendar components.
michael@0:  *     
michael@0:  *        Description: In a group scheduled calendar component, the property is
michael@0:  *        used by the &quot;Organizer&quot; to provide a confirmation of the event to the
michael@0:  *        &quot;Attendees&quot;. For example in a &quot;VEVENT&quot; calendar component, the
michael@0:  *        &quot;Organizer&quot; can indicate that a meeting is tentative, confirmed or
michael@0:  *        cancelled. In a &quot;VTODO&quot; calendar component, the &quot;Organizer&quot; can
michael@0:  *        indicate that an action item needs action, is completed, is in
michael@0:  *        process or being worked on, or has been cancelled. In a &quot;VJOURNAL&quot;
michael@0:  *        calendar component, the &quot;Organizer&quot; can indicate that a journal entry
michael@0:  *        is draft, final or has been cancelled or removed.
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          status     = &quot;STATUS&quot; statparam] &quot;:&quot; statvalue CRLF
michael@0:  *     
michael@0:  *          statparam  = *(&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *          statvalue  = &quot;TENTATIVE&quot;           ;Indicates event is
michael@0:  *                                             ;tentative.
michael@0:  *                     / &quot;CONFIRMED&quot;           ;Indicates event is
michael@0:  *                                             ;definite.
michael@0:  *                     / &quot;CANCELLED&quot;           ;Indicates event was
michael@0:  *                                             ;cancelled.
michael@0:  *             ;Status values for a &quot;VEVENT&quot;
michael@0:  *     
michael@0:  *          statvalue  =/ &quot;NEEDS-ACTION&quot;       ;Indicates to-do needs action.
michael@0:  *                     / &quot;COMPLETED&quot;           ;Indicates to-do completed.
michael@0:  *                     / &quot;IN-PROCESS&quot;          ;Indicates to-do in process of
michael@0:  *                     / &quot;CANCELLED&quot;           ;Indicates to-do was cancelled.
michael@0:  *             ;Status values for &quot;VTODO&quot;.
michael@0:  *     
michael@0:  *          statvalue  =/ &quot;DRAFT&quot;              ;Indicates journal is draft.
michael@0:  *                     / &quot;FINAL&quot;               ;Indicates journal is final.
michael@0:  *                     / &quot;CANCELLED&quot;           ;Indicates journal is removed.
michael@0:  *             ;Status values for &quot;VJOURNAL&quot;.
michael@0:  *     
michael@0:  *        Example: The following is an example of this property for a &quot;VEVENT&quot;
michael@0:  *        calendar component:
michael@0:  *     
michael@0:  *          STATUS:TENTATIVE
michael@0:  *     
michael@0:  *        The following is an example of this property for a &quot;VTODO&quot; calendar
michael@0:  *        component:
michael@0:  *     
michael@0:  *          STATUS:NEEDS-ACTION
michael@0:  *     
michael@0:  *        The following is an example of this property for a &quot;VJOURNAL&quot;
michael@0:  *        calendar component:
michael@0:  *     
michael@0:  *          STATUS:DRAFT
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class Status extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = 7401102230299289898L;
michael@0: 
michael@0:     // Status values for a "VEVENT"
michael@0:     /**
michael@0:      * Tentative VEVENT status.
michael@0:      */
michael@0:     public static final Status VEVENT_TENTATIVE = new ImmutableStatus(
michael@0:             "TENTATIVE");
michael@0: 
michael@0:     /**
michael@0:      * Confirmed VEVENT status.
michael@0:      */
michael@0:     public static final Status VEVENT_CONFIRMED = new ImmutableStatus(
michael@0:             "CONFIRMED");
michael@0: 
michael@0:     /**
michael@0:      * Cancelled VEVENT status.
michael@0:      */
michael@0:     public static final Status VEVENT_CANCELLED = new ImmutableStatus(
michael@0:             "CANCELLED");
michael@0: 
michael@0:     // Status values for "VTODO"
michael@0:     /**
michael@0:      * Tentative VTODO status.
michael@0:      */
michael@0:     public static final Status VTODO_NEEDS_ACTION = new ImmutableStatus(
michael@0:             "NEEDS-ACTION");
michael@0: 
michael@0:     /**
michael@0:      * Completed VTODO status.
michael@0:      */
michael@0:     public static final Status VTODO_COMPLETED = new ImmutableStatus(
michael@0:             "COMPLETED");
michael@0: 
michael@0:     /**
michael@0:      * In-process VTODO status.
michael@0:      */
michael@0:     public static final Status VTODO_IN_PROCESS = new ImmutableStatus(
michael@0:             "IN-PROCESS");
michael@0: 
michael@0:     /**
michael@0:      * Cancelled VTODO status.
michael@0:      */
michael@0:     public static final Status VTODO_CANCELLED = new ImmutableStatus(
michael@0:             "CANCELLED");
michael@0: 
michael@0:     // Status values for "VJOURNAL"
michael@0:     /**
michael@0:      * Draft VJOURNAL status.
michael@0:      */
michael@0:     public static final Status VJOURNAL_DRAFT = new ImmutableStatus("DRAFT");
michael@0: 
michael@0:     /**
michael@0:      * Final VJOURNAL status.
michael@0:      */
michael@0:     public static final Status VJOURNAL_FINAL = new ImmutableStatus("FINAL");
michael@0: 
michael@0:     /**
michael@0:      * Cancelled VJOURNAL status.
michael@0:      */
michael@0:     public static final Status VJOURNAL_CANCELLED = new ImmutableStatus(
michael@0:             "CANCELLED");
michael@0: 
michael@0:     /**
michael@0:      * @author Ben Fortuna An immutable instance of Status.
michael@0:      */
michael@0:     private static final class ImmutableStatus extends Status {
michael@0: 
michael@0:         private static final long serialVersionUID = 7771868877237685612L;
michael@0: 
michael@0:         private ImmutableStatus(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 Status() {
michael@0:         super(STATUS, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public Status(final String aValue) {
michael@0:         super(STATUS, 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 Status(final ParameterList aList, final String aValue) {
michael@0:         super(STATUS, 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: }