001    package ezvcard.parameters;
002    
003    /*
004     Copyright (c) 2012, 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     The views and conclusions contained in the software and documentation are those
028     of the authors and should not be interpreted as representing official policies, 
029     either expressed or implied, of the FreeBSD Project.
030     */
031    
032    /**
033     * Represents the TYPE parameter of the RELATED type.
034     * <p>
035     * vCard versions: 4.0
036     * </p>
037     * @author Michael Angstadt
038     */
039    public class RelatedTypeParameter extends TypeParameter {
040            public static final RelatedTypeParameter ACQUAINTANCE = new RelatedTypeParameter("acquaintance");
041            public static final RelatedTypeParameter AGENT = new RelatedTypeParameter("agent");
042            public static final RelatedTypeParameter CHILD = new RelatedTypeParameter("child");
043            public static final RelatedTypeParameter CO_RESIDENT = new RelatedTypeParameter("co-resident");
044            public static final RelatedTypeParameter CO_WORKER = new RelatedTypeParameter("co-worker");
045            public static final RelatedTypeParameter COLLEAGUE = new RelatedTypeParameter("colleague");
046            public static final RelatedTypeParameter CONTACT = new RelatedTypeParameter("contact");
047            public static final RelatedTypeParameter CRUSH = new RelatedTypeParameter("crush");
048            public static final RelatedTypeParameter DATE = new RelatedTypeParameter("date");
049            public static final RelatedTypeParameter EMERGENCY = new RelatedTypeParameter("emergency");
050            public static final RelatedTypeParameter FRIEND = new RelatedTypeParameter("friend");
051            public static final RelatedTypeParameter KIN = new RelatedTypeParameter("kin");
052            public static final RelatedTypeParameter ME = new RelatedTypeParameter("me");
053            public static final RelatedTypeParameter MET = new RelatedTypeParameter("met");
054            public static final RelatedTypeParameter MUSE = new RelatedTypeParameter("muse");
055            public static final RelatedTypeParameter NEIGHBOR = new RelatedTypeParameter("neighbor");
056            public static final RelatedTypeParameter PARENT = new RelatedTypeParameter("parent");
057            public static final RelatedTypeParameter SIBLING = new RelatedTypeParameter("sibling");
058            public static final RelatedTypeParameter SPOUSE = new RelatedTypeParameter("spouse");
059            public static final RelatedTypeParameter SWEETHEART = new RelatedTypeParameter("sweetheart");
060    
061            /**
062             * Use of this constructor is discouraged and should only be used for
063             * defining non-standard TYPEs. Please use one of the predefined static
064             * objects.
065             * @param value the type value (e.g. "spouse")
066             */
067            public RelatedTypeParameter(String value) {
068                    super(value);
069            }
070    
071            /**
072             * Searches the static objects in this class for one that has a certain type
073             * value.
074             * @param value the type value to search for (e.g. "spouse")
075             * @return the object or null if not found
076             */
077            public static RelatedTypeParameter valueOf(String value) {
078                    return findByValue(value, RelatedTypeParameter.class);
079            }
080    }