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 hierarchical relationship that a component has with another
030     * component.
031     * @author Michael Angstadt
032     * @see <a href="http://tools.ietf.org/html/rfc5545#page-25">RFC 5545 p.25</a>
033     */
034    public class RelationshipType extends EnumParameterValue {
035            private static final ICalParameterCaseClasses<RelationshipType> enums = new ICalParameterCaseClasses<RelationshipType>(RelationshipType.class);
036    
037            public static final RelationshipType PARENT = new RelationshipType("PARENT");
038    
039            public static final RelationshipType CHILD = new RelationshipType("CHILD");
040    
041            public static final RelationshipType SIBLING = new RelationshipType("SIBLING");
042    
043            private RelationshipType(String value) {
044                    super(value);
045            }
046    
047            /**
048             * Searches for a parameter value that is defined as a static constant in
049             * this class.
050             * @param value the parameter value
051             * @return the object or null if not found
052             */
053            public static RelationshipType find(String value) {
054                    return enums.find(value);
055            }
056    
057            /**
058             * Searches for a parameter value and creates one if it cannot be found. All
059             * objects are guaranteed to be unique, so they can be compared with
060             * <code>==</code> equality.
061             * @param value the parameter value
062             * @return the object
063             */
064            public static RelationshipType get(String value) {
065                    return enums.get(value);
066            }
067    }