net.sf.mpxj
Class Priority

java.lang.Object
  net.sf.mpxj.Priority

public final class Priority
extends Object

This class is used to represent a priority. It provides a mapping between the textual description of a priority found in an MPX file, and an enumerated representation that can be more easily manipulated programatically.

Field Summary

static int	DO_NOT_LEVEL Constant for do not level.
static int	HIGH Constant for high priority.
static int	HIGHER Constant for higher priority.
static int	HIGHEST Constant for highest priority.
static int	LOW Constant for low priority.
static int	LOWER Constant for lower priority.
static int	LOWEST Constant for lowest priority.
static int	MEDIUM Constant for medium priority.
static int	VERY_HIGH Constant for very high priority.
static int	VERY_LOW Constant for low priority.

Method Summary

static Priority	getInstance(int priority) This method takes an integer enumeration of a priority and returns an appropriate instance of this class.
int	getValue() Accessor method used to retrieve the numeric representation of the priority.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOWEST

public static final int LOWEST

Constant for lowest priority.

See Also:

Constant Field Values

VERY_LOW

public static final int VERY_LOW

Constant for low priority.

See Also:

Constant Field Values

LOWER

public static final int LOWER

Constant for lower priority.

See Also:

Constant Field Values

LOW

public static final int LOW

Constant for low priority.

See Also:

Constant Field Values

MEDIUM

public static final int MEDIUM

Constant for medium priority.

See Also:

Constant Field Values

HIGH

public static final int HIGH

Constant for high priority.

See Also:

Constant Field Values

HIGHER

public static final int HIGHER

Constant for higher priority.

See Also:

Constant Field Values

VERY_HIGH

public static final int VERY_HIGH

Constant for very high priority.

See Also:

Constant Field Values

HIGHEST

public static final int HIGHEST

Constant for highest priority.

See Also:

Constant Field Values

DO_NOT_LEVEL

public static final int DO_NOT_LEVEL

Constant for do not level.

See Also:

Constant Field Values

Method Detail

getInstance

public static Priority getInstance(int priority)

This method takes an integer enumeration of a priority and returns an appropriate instance of this class. Note that unrecognised values are treated as medium priority.

Parameters:

priority - int version of the priority

Returns:

Priority class instance

getValue

public int getValue()

Accessor method used to retrieve the numeric representation of the priority.

Returns:

int representation of the priority