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