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