001package 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 * Defines the priority of an event or to-do task.
031 * </p>
032 * <p>
033 * <b>Code sample:</b>
034 * 
035 * <pre class="brush:java">
036 * VEvent event = new VEvent();
037 * 
038 * event.setPriority(1); //highest
039 * event.setPriority(9); //lowest
040 * </pre>
041 * 
042 * </p>
043 * @author Michael Angstadt
044 * @see <a href="http://tools.ietf.org/html/rfc5545#page-89">RFC 5545 p.89-90</a>
045 */
046public class Priority extends IntegerProperty {
047        /**
048         * Creates a priority property.
049         * @param priority the priority ("0" is undefined, "1" is the highest, "9"
050         * is the lowest)
051         */
052        public Priority(Integer priority) {
053                super(priority);
054        }
055
056        /**
057         * Determines if this priority is considered "high" priority.
058         * @return true if the priority is between 1 and 4, false if not
059         */
060        public boolean isHigh() {
061                return value != null && value >= 1 && value <= 4;
062        }
063
064        /**
065         * Determines if this priority is considered "medium" priority.
066         * @return true if the priority is "5", false if not
067         */
068        public boolean isMedium() {
069                return value != null && value == 5;
070        }
071
072        /**
073         * Determines if this priority is considered "low" priority.
074         * @return true if the priority is between 6 and 9, false if not
075         */
076        public boolean isLow() {
077                return value != null && value >= 6 && value <= 9;
078        }
079
080        /**
081         * Determines if this priority has an "undefined" value.
082         * @return true if the priority is "0", false if not
083         */
084        public boolean isUndefined() {
085                return value != null && value == 0;
086        }
087
088        /**
089         * Converts this priority to its two-character CUA code.
090         * @return the CUA code (e.g. "B1" for "4") or null if the priority cannot
091         * be converted to a CUA code
092         */
093        public String toCuaPriority() {
094                if (value == null || value < 1 || value > 9) {
095                        return null;
096                }
097                int letter = ((value - 1) / 3) + 'A';
098                int number = ((value - 1) % 3) + 1;
099                return (char) letter + "" + number;
100        }
101}