001    package biweekly.parameter;
002    
003    import java.util.Collection;
004    
005    import biweekly.property.RecurrenceId;
006    
007    /*
008     Copyright (c) 2013, Michael Angstadt
009     All rights reserved.
010    
011     Redistribution and use in source and binary forms, with or without
012     modification, are permitted provided that the following conditions are met: 
013    
014     1. Redistributions of source code must retain the above copyright notice, this
015     list of conditions and the following disclaimer. 
016     2. Redistributions in binary form must reproduce the above copyright notice,
017     this list of conditions and the following disclaimer in the documentation
018     and/or other materials provided with the distribution. 
019    
020     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030     */
031    
032    /**
033     * Defines the effective range of recurrence instances specified by the
034     * {@link RecurrenceId} property. This parameter is essentially deprecated.
035     * @author Michael Angstadt
036     * @rfc 5545 p.23-4
037     */
038    public class Range extends EnumParameterValue {
039            private static final ICalParameterCaseClasses<Range> enums = new ICalParameterCaseClasses<Range>(Range.class);
040    
041            public static final Range THIS_AND_FUTURE = new Range("THISANDFUTURE");
042    
043            /**
044             * Deprecated in the latest iCal specification.
045             */
046            public static final Range THIS_AND_PRIOR = new Range("THISANDPRIOR");
047    
048            private Range(String value) {
049                    super(value);
050            }
051    
052            /**
053             * Searches for a parameter value that is defined as a static constant in
054             * this class.
055             * @param value the parameter value
056             * @return the object or null if not found
057             */
058            public static Range find(String value) {
059                    return enums.find(value);
060            }
061    
062            /**
063             * Searches for a parameter value and creates one if it cannot be found. All
064             * objects are guaranteed to be unique, so they can be compared with
065             * {@code ==} equality.
066             * @param value the parameter value
067             * @return the object
068             */
069            public static Range get(String value) {
070                    return enums.get(value);
071            }
072    
073            /**
074             * Gets all of the parameter values that are defined as static constants in
075             * this class.
076             * @return the parameter values
077             */
078            public static Collection<Range> all() {
079                    return enums.all();
080            }
081    }