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