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 the hierarchical relationship that a component has with another
032     * component.
033     * @author Michael Angstadt
034     * @rfc 5545 p.25
035     */
036    public class RelationshipType extends EnumParameterValue {
037            private static final ICalParameterCaseClasses<RelationshipType> enums = new ICalParameterCaseClasses<RelationshipType>(RelationshipType.class);
038    
039            public static final RelationshipType PARENT = new RelationshipType("PARENT");
040    
041            public static final RelationshipType CHILD = new RelationshipType("CHILD");
042    
043            public static final RelationshipType SIBLING = new RelationshipType("SIBLING");
044    
045            private RelationshipType(String value) {
046                    super(value);
047            }
048    
049            /**
050             * Searches for a parameter value that is defined as a static constant in
051             * this class.
052             * @param value the parameter value
053             * @return the object or null if not found
054             */
055            public static RelationshipType find(String value) {
056                    return enums.find(value);
057            }
058    
059            /**
060             * Searches for a parameter value and creates one if it cannot be found. All
061             * objects are guaranteed to be unique, so they can be compared with
062             * {@code ==} equality.
063             * @param value the parameter value
064             * @return the object
065             */
066            public static RelationshipType get(String value) {
067                    return enums.get(value);
068            }
069    
070            /**
071             * Gets all of the parameter values that are defined as static constants in
072             * this class.
073             * @return the parameter values
074             */
075            public static Collection<RelationshipType> all() {
076                    return enums.all();
077            }
078    }