001package biweekly.parameter;
002
003import java.util.Collection;
004
005/*
006 Copyright (c) 2013-2015, 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 date that an alarm trigger is relative to.
032 * @author Michael Angstadt
033 * @see <a href="http://tools.ietf.org/html/rfc5545#page-24">RFC 5545 p.24</a>
034 */
035public class Related extends EnumParameterValue {
036        private static final ICalParameterCaseClasses<Related> enums = new ICalParameterCaseClasses<Related>(Related.class);
037
038        public static final Related START = new Related("START");
039
040        public static final Related END = new Related("END");
041
042        private Related(String value) {
043                super(value);
044        }
045
046        /**
047         * Searches for a parameter value that is defined as a static constant in
048         * this class.
049         * @param value the parameter value
050         * @return the object or null if not found
051         */
052        public static Related find(String value) {
053                return enums.find(value);
054        }
055
056        /**
057         * Searches for a parameter value and creates one if it cannot be found. All
058         * objects are guaranteed to be unique, so they can be compared with
059         * {@code ==} equality.
060         * @param value the parameter value
061         * @return the object
062         */
063        public static Related get(String value) {
064                return enums.get(value);
065        }
066
067        /**
068         * Gets all of the parameter values that are defined as static constants in
069         * this class.
070         * @return the parameter values
071         */
072        public static Collection<Related> all() {
073                return enums.all();
074        }
075}