biweekly.property

Class Priority

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<Integer>

biweekly.property.IntegerProperty

biweekly.property.Priority

public class Priority
extends IntegerProperty

Defines the priority of an event or to-do task.

Code sample:

 VEvent event = new VEvent();
 
 event.setPriority(1); //highest
 event.setPriority(9); //lowest
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.89-90, RFC 2445 p.85-7, vCal 1.0 p.33

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Priority(Integer priority) Creates a priority property.
Priority(Priority original) Copy constructor.

Method Summary

Modifier and Type	Method and Description
Priority	copy() Creates a copy of this property object.
boolean	isHigh() Determines if this priority is considered "high" priority.
boolean	isLow() Determines if this priority is considered "low" priority.
boolean	isMedium() Determines if this priority is considered "medium" priority.
boolean	isUndefined() Determines if this priority has an "undefined" value.
String	toCuaPriority() Converts this priority to its two-character CUA code.

Methods inherited from class biweekly.property.ValuedProperty

equals, getValue, getValue, hashCode, setValue, toStringValues, validate, valueEquals, valueHashCode

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Priority

public Priority(Integer priority)

Creates a priority property.

Parameters:

priority - the priority ("0" is undefined, "1" is the highest, "9" is the lowest)

Priority

public Priority(Priority original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

isHigh

public boolean isHigh()

Determines if this priority is considered "high" priority.

Returns:

true if the priority is between 1 and 4, false if not

isMedium

public boolean isMedium()

Determines if this priority is considered "medium" priority.

Returns:

true if the priority is "5", false if not

isLow

public boolean isLow()

Determines if this priority is considered "low" priority.

Returns:

true if the priority is between 6 and 9, false if not

isUndefined

public boolean isUndefined()

Determines if this priority has an "undefined" value.

Returns:

true if the priority is "0", false if not

toCuaPriority

public String toCuaPriority()

Converts this priority to its two-character CUA code.

Returns:

the CUA code (e.g. "B1" for "4") or null if the priority cannot be converted to a CUA code

copy

public Priority copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy