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 whether a calendar user is free or busy over a time period.
032 * @author Michael Angstadt
033 * @see <a href="http://tools.ietf.org/html/rfc5545#page-20">RFC 5545 p.20-1</a>
034 */
035public class FreeBusyType extends EnumParameterValue {
036        private static final ICalParameterCaseClasses<FreeBusyType> enums = new ICalParameterCaseClasses<FreeBusyType>(FreeBusyType.class);
037
038        public static final FreeBusyType FREE = new FreeBusyType("FREE");
039        public static final FreeBusyType BUSY = new FreeBusyType("BUSY");
040        public static final FreeBusyType BUSY_UNAVAILABLE = new FreeBusyType("BUSY-UNAVAILABLE");
041        public static final FreeBusyType BUSY_TENTATIVE = new FreeBusyType("BUSY-TENTATIVE");
042
043        private FreeBusyType(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 FreeBusyType 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 ==} equality.
061         * @param value the parameter value
062         * @return the object
063         */
064        public static FreeBusyType get(String value) {
065                return enums.get(value);
066        }
067
068        /**
069         * Gets all of the parameter values that are defined as static constants in
070         * this class.
071         * @return the parameter values
072         */
073        public static Collection<FreeBusyType> all() {
074                return enums.all();
075        }
076}