org.scijava
Class Priority

java.lang.Object
  org.scijava.Priority

public final class Priority
extends Object

Constants for specifying an item's priority.

Author:

Johannes Schindelin, Curtis Rueden

See Also:

Prioritized.getPriority(), Plugin.priority()

Field Summary

static double	FIRST_PRIORITY Priority for items that must be sorted first.
static double	HIGH_PRIORITY Priority for items that prefer to be sorted earlier.
static double	LAST_PRIORITY Priority for items that must be sorted last.
static double	LOW_PRIORITY Priority for items that prefer to be sorted later.
static double	NORMAL_PRIORITY Default priority for items.
static double	VERY_HIGH_PRIORITY Priority for items that strongly prefer to be sorted early.
static double	VERY_LOW_PRIORITY Priority for items that strongly prefer to be sorted late.

Method Summary

static int	compare(Prioritized p1, Prioritized p2) Compares two Prioritized objects.
static boolean	inject(Object o, double priority) Injects the specified priority into the given object.

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_PRIORITY

public static final double FIRST_PRIORITY

Priority for items that must be sorted first.

See Also:

Constant Field Values

VERY_HIGH_PRIORITY

public static final double VERY_HIGH_PRIORITY

Priority for items that strongly prefer to be sorted early.

See Also:

Constant Field Values

HIGH_PRIORITY

public static final double HIGH_PRIORITY

Priority for items that prefer to be sorted earlier.

See Also:

Constant Field Values

NORMAL_PRIORITY

public static final double NORMAL_PRIORITY

Default priority for items.

See Also:

Constant Field Values

LOW_PRIORITY

public static final double LOW_PRIORITY

Priority for items that prefer to be sorted later.

See Also:

Constant Field Values

VERY_LOW_PRIORITY

public static final double VERY_LOW_PRIORITY

Priority for items that strongly prefer to be sorted late.

See Also:

Constant Field Values

LAST_PRIORITY

public static final double LAST_PRIORITY

Priority for items that must be sorted last.

See Also:

Constant Field Values

Method Detail

compare

public static int compare(Prioritized p1,
                          Prioritized p2)

Compares two Prioritized objects.

Note: this method provides a natural ordering that may be inconsistent with equals. That is, two unequal objects may often have the same priority, and thus return 0 when compared in this fashion. Hence, if this method is used as a basis for implementing Comparable.compareTo(T) or Comparator.compare(T, T), that implementation may want to impose logic beyond that of this method, for breaking ties, if a total ordering consistent with equals is always required.

Returns:

-1 if p1's priority is higher than p2's, 1 if p2's priority is higher than p1's, or 0 if they have the same priority.

See Also:

ClassUtils.compare(Class, Class)

inject

public static boolean inject(Object o,
                             double priority)

Injects the specified priority into the given object. Note that this is only possible if the given object implements the Prioritized interface.

Parameters:

o - The object to which the priority should be assigned.

Returns:

true If the priority was successfully injected.