001    package biweekly.parameter;
002    
003    import biweekly.property.RecurrenceId;
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 effective range of recurrence instances specified by the
032     * {@link RecurrenceId} property. This parameter is essentially deprecated.
033     * @author Michael Angstadt
034     * @see <a href="http://tools.ietf.org/html/rfc5545#page-23">RFC 5545 p.23-4</a>
035     */
036    public class Range extends EnumParameterValue {
037            private static final ICalParameterCaseClasses<Range> enums = new ICalParameterCaseClasses<Range>(Range.class);
038    
039            public static final Range THIS_AND_FUTURE = new Range("THISANDFUTURE");
040    
041            /**
042             * Deprecated in the latest iCal specification.
043             */
044            public static final Range THIS_AND_PRIOR = new Range("THISANDPRIOR");
045    
046            private Range(String value) {
047                    super(value);
048            }
049    
050            /**
051             * Searches for a parameter value that is defined as a static constant in
052             * this class.
053             * @param value the parameter value
054             * @return the object or null if not found
055             */
056            public static Range find(String value) {
057                    return enums.find(value);
058            }
059    
060            /**
061             * Searches for a parameter value and creates one if it cannot be found. All
062             * objects are guaranteed to be unique, so they can be compared with
063             * <code>==</code> equality.
064             * @param value the parameter value
065             * @return the object
066             */
067            public static Range get(String value) {
068                    return enums.get(value);
069            }
070    }