001    package biweekly.property;
002    
003    import java.util.Arrays;
004    import java.util.Collection;
005    
006    /*
007     Copyright (c) 2013, Michael Angstadt
008     All rights reserved.
009    
010     Redistribution and use in source and binary forms, with or without
011     modification, are permitted provided that the following conditions are met: 
012    
013     1. Redistributions of source code must retain the above copyright notice, this
014     list of conditions and the following disclaimer. 
015     2. Redistributions in binary form must reproduce the above copyright notice,
016     this list of conditions and the following disclaimer in the documentation
017     and/or other materials provided with the distribution. 
018    
019     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
026     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029     */
030    
031    /**
032     * <p>
033     * Specifies the calendar system that this iCalendar object uses. If none is
034     * specified, then the calendar is assumed to be in "gregorian" format.
035     * </p>
036     * <p>
037     * <b>Examples:</b>
038     * 
039     * <pre class="brush:java">
040     * //creating a new property
041     * CalendarScale calscale = CalendarScale.gregorian();
042     * 
043     * if (calscale.isGregorian()) {
044     *      //its value is &quot;GREGORIAN&quot;
045     * }
046     * </pre>
047     * 
048     * </p>
049     * @author Michael Angstadt
050     * @rfc 5545 p.76-7
051     */
052    public class CalendarScale extends EnumProperty {
053            private static final String GREGORIAN = "GREGORIAN";
054    
055            /**
056             * Creates a new calendar scale property. Use of this constructor is
057             * discouraged and may put the property in an invalid state. Use one of the
058             * static factory methods instead.
059             * @param value the value of the property (e.g. "gregorian")
060             */
061            public CalendarScale(String value) {
062                    super(value);
063            }
064    
065            /**
066             * Creates a new property whose value is set to "gregorian".
067             * @return the new property
068             */
069            public static CalendarScale gregorian() {
070                    return new CalendarScale(GREGORIAN);
071            }
072    
073            /**
074             * Determines whether the property is set to "gregorian".
075             * @return true if it's set to "gregorian", false if not
076             */
077            public boolean isGregorian() {
078                    return is(GREGORIAN);
079            }
080    
081            @Override
082            protected Collection<String> getStandardValues() {
083                    return Arrays.asList(GREGORIAN);
084            }
085    }