src/net/fortuna/ical4j/model/property/Status.java@45d57ecba757 (annotated)
src/net/fortuna/ical4j/model/property/Status.java
Tue, 10 Feb 2015 19:58:00 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 10 Feb 2015 19:58:00 +0100
- changeset 4
- 45d57ecba757
- permissions
- -rw-r--r--
Upgrade the upgraded ical4j component to use org.apache.commons.lang3.
| michael@0 | 1 | /** |
| michael@0 | 2 | * Copyright (c) 2012, Ben Fortuna |
| michael@0 | 3 | * All rights reserved. |
| michael@0 | 4 | * |
| michael@0 | 5 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 6 | * modification, are permitted provided that the following conditions |
| michael@0 | 7 | * are met: |
| michael@0 | 8 | * |
| michael@0 | 9 | * o Redistributions of source code must retain the above copyright |
| michael@0 | 10 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 11 | * |
| michael@0 | 12 | * o Redistributions in binary form must reproduce the above copyright |
| michael@0 | 13 | * notice, this list of conditions and the following disclaimer in the |
| michael@0 | 14 | * documentation and/or other materials provided with the distribution. |
| michael@0 | 15 | * |
| michael@0 | 16 | * o Neither the name of Ben Fortuna nor the names of any other contributors |
| michael@0 | 17 | * may be used to endorse or promote products derived from this software |
| michael@0 | 18 | * without specific prior written permission. |
| michael@0 | 19 | * |
| michael@0 | 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| michael@0 | 24 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| michael@0 | 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| michael@0 | 26 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| michael@0 | 27 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| michael@0 | 28 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| michael@0 | 29 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| michael@0 | 30 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 31 | */ |
| michael@0 | 32 | package net.fortuna.ical4j.model.property; |
| michael@0 | 33 | |
| michael@0 | 34 | import net.fortuna.ical4j.model.ParameterList; |
| michael@0 | 35 | import net.fortuna.ical4j.model.Property; |
| michael@0 | 36 | import net.fortuna.ical4j.model.PropertyFactoryImpl; |
| michael@0 | 37 | import net.fortuna.ical4j.model.ValidationException; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * $Id$ |
| michael@0 | 41 | * |
| michael@0 | 42 | * Created: [Apr 6, 2004] |
| michael@0 | 43 | * |
| michael@0 | 44 | * Defines a STATUS iCalendar component property. |
| michael@0 | 45 | * |
| michael@0 | 46 | * <pre> |
| michael@0 | 47 | * 4.8.1.11 Status |
| michael@0 | 48 | * |
| michael@0 | 49 | * Property Name: STATUS |
| michael@0 | 50 | * |
| michael@0 | 51 | * Purpose: This property defines the overall status or confirmation for |
| michael@0 | 52 | * the calendar component. |
| michael@0 | 53 | * |
| michael@0 | 54 | * Value Type: TEXT |
| michael@0 | 55 | * |
| michael@0 | 56 | * Property Parameters: Non-standard property parameters can be |
| michael@0 | 57 | * specified on this property. |
| michael@0 | 58 | * |
| michael@0 | 59 | * Conformance: This property can be specified in "VEVENT", "VTODO" or |
| michael@0 | 60 | * "VJOURNAL" calendar components. |
| michael@0 | 61 | * |
| michael@0 | 62 | * Description: In a group scheduled calendar component, the property is |
| michael@0 | 63 | * used by the "Organizer" to provide a confirmation of the event to the |
| michael@0 | 64 | * "Attendees". For example in a "VEVENT" calendar component, the |
| michael@0 | 65 | * "Organizer" can indicate that a meeting is tentative, confirmed or |
| michael@0 | 66 | * cancelled. In a "VTODO" calendar component, the "Organizer" can |
| michael@0 | 67 | * indicate that an action item needs action, is completed, is in |
| michael@0 | 68 | * process or being worked on, or has been cancelled. In a "VJOURNAL" |
| michael@0 | 69 | * calendar component, the "Organizer" can indicate that a journal entry |
| michael@0 | 70 | * is draft, final or has been cancelled or removed. |
| michael@0 | 71 | * |
| michael@0 | 72 | * Format Definition: The property is defined by the following notation: |
| michael@0 | 73 | * |
| michael@0 | 74 | * status = "STATUS" statparam] ":" statvalue CRLF |
| michael@0 | 75 | * |
| michael@0 | 76 | * statparam = *(";" xparam) |
| michael@0 | 77 | * |
| michael@0 | 78 | * statvalue = "TENTATIVE" ;Indicates event is |
| michael@0 | 79 | * ;tentative. |
| michael@0 | 80 | * / "CONFIRMED" ;Indicates event is |
| michael@0 | 81 | * ;definite. |
| michael@0 | 82 | * / "CANCELLED" ;Indicates event was |
| michael@0 | 83 | * ;cancelled. |
| michael@0 | 84 | * ;Status values for a "VEVENT" |
| michael@0 | 85 | * |
| michael@0 | 86 | * statvalue =/ "NEEDS-ACTION" ;Indicates to-do needs action. |
| michael@0 | 87 | * / "COMPLETED" ;Indicates to-do completed. |
| michael@0 | 88 | * / "IN-PROCESS" ;Indicates to-do in process of |
| michael@0 | 89 | * / "CANCELLED" ;Indicates to-do was cancelled. |
| michael@0 | 90 | * ;Status values for "VTODO". |
| michael@0 | 91 | * |
| michael@0 | 92 | * statvalue =/ "DRAFT" ;Indicates journal is draft. |
| michael@0 | 93 | * / "FINAL" ;Indicates journal is final. |
| michael@0 | 94 | * / "CANCELLED" ;Indicates journal is removed. |
| michael@0 | 95 | * ;Status values for "VJOURNAL". |
| michael@0 | 96 | * |
| michael@0 | 97 | * Example: The following is an example of this property for a "VEVENT" |
| michael@0 | 98 | * calendar component: |
| michael@0 | 99 | * |
| michael@0 | 100 | * STATUS:TENTATIVE |
| michael@0 | 101 | * |
| michael@0 | 102 | * The following is an example of this property for a "VTODO" calendar |
| michael@0 | 103 | * component: |
| michael@0 | 104 | * |
| michael@0 | 105 | * STATUS:NEEDS-ACTION |
| michael@0 | 106 | * |
| michael@0 | 107 | * The following is an example of this property for a "VJOURNAL" |
| michael@0 | 108 | * calendar component: |
| michael@0 | 109 | * |
| michael@0 | 110 | * STATUS:DRAFT |
| michael@0 | 111 | * </pre> |
| michael@0 | 112 | * |
| michael@0 | 113 | * @author Ben Fortuna |
| michael@0 | 114 | */ |
| michael@0 | 115 | public class Status extends Property { |
| michael@0 | 116 | |
| michael@0 | 117 | private static final long serialVersionUID = 7401102230299289898L; |
| michael@0 | 118 | |
| michael@0 | 119 | // Status values for a "VEVENT" |
| michael@0 | 120 | /** |
| michael@0 | 121 | * Tentative VEVENT status. |
| michael@0 | 122 | */ |
| michael@0 | 123 | public static final Status VEVENT_TENTATIVE = new ImmutableStatus( |
| michael@0 | 124 | "TENTATIVE"); |
| michael@0 | 125 | |
| michael@0 | 126 | /** |
| michael@0 | 127 | * Confirmed VEVENT status. |
| michael@0 | 128 | */ |
| michael@0 | 129 | public static final Status VEVENT_CONFIRMED = new ImmutableStatus( |
| michael@0 | 130 | "CONFIRMED"); |
| michael@0 | 131 | |
| michael@0 | 132 | /** |
| michael@0 | 133 | * Cancelled VEVENT status. |
| michael@0 | 134 | */ |
| michael@0 | 135 | public static final Status VEVENT_CANCELLED = new ImmutableStatus( |
| michael@0 | 136 | "CANCELLED"); |
| michael@0 | 137 | |
| michael@0 | 138 | // Status values for "VTODO" |
| michael@0 | 139 | /** |
| michael@0 | 140 | * Tentative VTODO status. |
| michael@0 | 141 | */ |
| michael@0 | 142 | public static final Status VTODO_NEEDS_ACTION = new ImmutableStatus( |
| michael@0 | 143 | "NEEDS-ACTION"); |
| michael@0 | 144 | |
| michael@0 | 145 | /** |
| michael@0 | 146 | * Completed VTODO status. |
| michael@0 | 147 | */ |
| michael@0 | 148 | public static final Status VTODO_COMPLETED = new ImmutableStatus( |
| michael@0 | 149 | "COMPLETED"); |
| michael@0 | 150 | |
| michael@0 | 151 | /** |
| michael@0 | 152 | * In-process VTODO status. |
| michael@0 | 153 | */ |
| michael@0 | 154 | public static final Status VTODO_IN_PROCESS = new ImmutableStatus( |
| michael@0 | 155 | "IN-PROCESS"); |
| michael@0 | 156 | |
| michael@0 | 157 | /** |
| michael@0 | 158 | * Cancelled VTODO status. |
| michael@0 | 159 | */ |
| michael@0 | 160 | public static final Status VTODO_CANCELLED = new ImmutableStatus( |
| michael@0 | 161 | "CANCELLED"); |
| michael@0 | 162 | |
| michael@0 | 163 | // Status values for "VJOURNAL" |
| michael@0 | 164 | /** |
| michael@0 | 165 | * Draft VJOURNAL status. |
| michael@0 | 166 | */ |
| michael@0 | 167 | public static final Status VJOURNAL_DRAFT = new ImmutableStatus("DRAFT"); |
| michael@0 | 168 | |
| michael@0 | 169 | /** |
| michael@0 | 170 | * Final VJOURNAL status. |
| michael@0 | 171 | */ |
| michael@0 | 172 | public static final Status VJOURNAL_FINAL = new ImmutableStatus("FINAL"); |
| michael@0 | 173 | |
| michael@0 | 174 | /** |
| michael@0 | 175 | * Cancelled VJOURNAL status. |
| michael@0 | 176 | */ |
| michael@0 | 177 | public static final Status VJOURNAL_CANCELLED = new ImmutableStatus( |
| michael@0 | 178 | "CANCELLED"); |
| michael@0 | 179 | |
| michael@0 | 180 | /** |
| michael@0 | 181 | * @author Ben Fortuna An immutable instance of Status. |
| michael@0 | 182 | */ |
| michael@0 | 183 | private static final class ImmutableStatus extends Status { |
| michael@0 | 184 | |
| michael@0 | 185 | private static final long serialVersionUID = 7771868877237685612L; |
| michael@0 | 186 | |
| michael@0 | 187 | private ImmutableStatus(final String value) { |
| michael@0 | 188 | super(new ParameterList(true), value); |
| michael@0 | 189 | } |
| michael@0 | 190 | |
| michael@0 | 191 | public void setValue(final String aValue) { |
| michael@0 | 192 | throw new UnsupportedOperationException( |
| michael@0 | 193 | "Cannot modify constant instances"); |
| michael@0 | 194 | } |
| michael@0 | 195 | } |
| michael@0 | 196 | |
| michael@0 | 197 | private String value; |
| michael@0 | 198 | |
| michael@0 | 199 | /** |
| michael@0 | 200 | * Default constructor. |
| michael@0 | 201 | */ |
| michael@0 | 202 | public Status() { |
| michael@0 | 203 | super(STATUS, PropertyFactoryImpl.getInstance()); |
| michael@0 | 204 | } |
| michael@0 | 205 | |
| michael@0 | 206 | /** |
| michael@0 | 207 | * @param aValue a value string for this component |
| michael@0 | 208 | */ |
| michael@0 | 209 | public Status(final String aValue) { |
| michael@0 | 210 | super(STATUS, PropertyFactoryImpl.getInstance()); |
| michael@0 | 211 | this.value = aValue; |
| michael@0 | 212 | } |
| michael@0 | 213 | |
| michael@0 | 214 | /** |
| michael@0 | 215 | * @param aList a list of parameters for this component |
| michael@0 | 216 | * @param aValue a value string for this component |
| michael@0 | 217 | */ |
| michael@0 | 218 | public Status(final ParameterList aList, final String aValue) { |
| michael@0 | 219 | super(STATUS, aList, PropertyFactoryImpl.getInstance()); |
| michael@0 | 220 | this.value = aValue; |
| michael@0 | 221 | } |
| michael@0 | 222 | |
| michael@0 | 223 | /** |
| michael@0 | 224 | * {@inheritDoc} |
| michael@0 | 225 | */ |
| michael@0 | 226 | public void setValue(final String aValue) { |
| michael@0 | 227 | this.value = aValue; |
| michael@0 | 228 | } |
| michael@0 | 229 | |
| michael@0 | 230 | /** |
| michael@0 | 231 | * {@inheritDoc} |
| michael@0 | 232 | */ |
| michael@0 | 233 | public final String getValue() { |
| michael@0 | 234 | return value; |
| michael@0 | 235 | } |
| michael@0 | 236 | |
| michael@0 | 237 | /** |
| michael@0 | 238 | * {@inheritDoc} |
| michael@0 | 239 | */ |
| michael@0 | 240 | public final void validate() throws ValidationException { |
| michael@0 | 241 | // TODO: Auto-generated method stub |
| michael@0 | 242 | } |
| michael@0 | 243 | } |
