001    package biweekly.parameter;
002    
003    import java.util.Collection;
004    
005    /*
006     Copyright (c) 2013, Michael Angstadt
007     All rights reserved.
008    
009     Redistribution and use in source and binary forms, with or without
010     modification, are permitted provided that the following conditions are met: 
011    
012     1. Redistributions of source code must retain the above copyright notice, this
013     list of conditions and the following disclaimer. 
014     2. Redistributions in binary form must reproduce the above copyright notice,
015     this list of conditions and the following disclaimer in the documentation
016     and/or other materials provided with the distribution. 
017    
018     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
019     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
020     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
025     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028     */
029    
030    /**
031     * Defines a calendar user's level of participation.
032     * @author Michael Angstadt
033     * @rfc 5545 p.22-3
034     */
035    public class ParticipationStatus extends EnumParameterValue {
036            private static final ICalParameterCaseClasses<ParticipationStatus> enums = new ICalParameterCaseClasses<ParticipationStatus>(ParticipationStatus.class);
037    
038            public static final ParticipationStatus NEEDS_ACTION = new ParticipationStatus("NEEDS-ACTION"); //VEVENT, VTODO, VJOURNAL
039            public static final ParticipationStatus ACCEPTED = new ParticipationStatus("ACCEPTED"); //VEVENT, VTODO, VJOURNAL
040            public static final ParticipationStatus DECLINED = new ParticipationStatus("DECLINED"); //VEVENT, VTODO, VJOURNAL
041            public static final ParticipationStatus TENTATIVE = new ParticipationStatus("TENTATIVE"); //VEVENT, VTODO
042            public static final ParticipationStatus DELEGATED = new ParticipationStatus("DELEGATED"); //VEVENT, VTODO
043            public static final ParticipationStatus COMPLETED = new ParticipationStatus("COMPLETED"); //VTODO
044            public static final ParticipationStatus IN_PROGRESS = new ParticipationStatus("IN_PROGRESS"); //VTODO
045    
046            private ParticipationStatus(String value) {
047                    super(value);
048            }
049    
050            /**
051             * Searches for a parameter value that is defined as a static constant in
052             * this class.
053             * @param value the parameter value
054             * @return the object or null if not found
055             */
056            public static ParticipationStatus find(String value) {
057                    return enums.find(value);
058            }
059    
060            /**
061             * Searches for a parameter value and creates one if it cannot be found. All
062             * objects are guaranteed to be unique, so they can be compared with
063             * {@code ==} equality.
064             * @param value the parameter value
065             * @return the object
066             */
067            public static ParticipationStatus get(String value) {
068                    return enums.get(value);
069            }
070    
071            /**
072             * Gets all of the parameter values that are defined as static constants in
073             * this class.
074             * @return the parameter values
075             */
076            public static Collection<ParticipationStatus> all() {
077                    return enums.all();
078            }
079    }