Priority (SciJava Javadocs 0-SNAPSHOT API)

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

Fields
Modifier and Type	Field and Description
`static double`	`EXTREMELY_HIGH` Priority for items that very strongly prefer to be sorted early.
`static double`	`EXTREMELY_LOW` Priority for items that very strongly prefer to be sorted late.
`static double`	`FIRST` Priority for items that must be sorted first.
`static double`	`FIRST_PRIORITY` Deprecated. Use `FIRST` instead.
`static double`	`HIGH` Priority for items that prefer to be sorted earlier.
`static double`	`HIGH_PRIORITY` Deprecated. Use `HIGH` instead.
`static double`	`LAST` Priority for items that must be sorted last.
`static double`	`LAST_PRIORITY` Deprecated. Use `LAST` instead.
`static double`	`LOW` Priority for items that prefer to be sorted later.
`static double`	`LOW_PRIORITY` Deprecated. Use `LOW` instead.
`static double`	`NORMAL` Default priority for items.
`static double`	`NORMAL_PRIORITY` Deprecated. Use `NORMAL` instead.
`static double`	`VERY_HIGH` Priority for items that strongly prefer to be sorted early.
`static double`	`VERY_HIGH_PRIORITY` Deprecated. Use `VERY_HIGH` instead.
`static double`	`VERY_LOW` Priority for items that strongly prefer to be sorted late.
`static double`	`VERY_LOW_PRIORITY` Deprecated. Use `VERY_LOW` instead.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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
```
public static final double FIRST
```
    Priority for items that must be sorted first.
    Note that it is still possible to prioritize something earlier than this value (e.g., for testing purposes), although doing so strongly discouraged in production.
    
    See Also:
    
    Constant Field Values
  - EXTREMELY_HIGH
```
public static final double EXTREMELY_HIGH
```
    Priority for items that very strongly prefer to be sorted early.
    
    See Also:
    
    Constant Field Values
  - VERY_HIGH
```
public static final double VERY_HIGH
```
    Priority for items that strongly prefer to be sorted early.
    
    See Also:
    
    Constant Field Values
  - HIGH
```
public static final double HIGH
```
    Priority for items that prefer to be sorted earlier.
    
    See Also:
    
    Constant Field Values
  - NORMAL
```
public static final double NORMAL
```
    Default priority for items.
    
    See Also:
    
    Constant Field Values
  - LOW
```
public static final double LOW
```
    Priority for items that prefer to be sorted later.
    
    See Also:
    
    Constant Field Values
  - VERY_LOW
```
public static final double VERY_LOW
```
    Priority for items that strongly prefer to be sorted late.
    
    See Also:
    
    Constant Field Values
  - EXTREMELY_LOW
```
public static final double EXTREMELY_LOW
```
    Priority for items that very strongly prefer to be sorted late.
    
    See Also:
    
    Constant Field Values
  - LAST
```
public static final double LAST
```
    Priority for items that must be sorted last.
    Note that it is still possible to prioritize something later than this value (e.g., for testing purposes), although doing so strongly discouraged in production.
    
    See Also:
    
    Constant Field Values
  - FIRST_PRIORITY
```
@Deprecated
public static final double FIRST_PRIORITY
```
    Deprecated. Use FIRST instead.
    
    See Also:
    
    Constant Field Values
  - VERY_HIGH_PRIORITY
```
@Deprecated
public static final double VERY_HIGH_PRIORITY
```
    Deprecated. Use VERY_HIGH instead.
    
    See Also:
    
    Constant Field Values
  - HIGH_PRIORITY
```
@Deprecated
public static final double HIGH_PRIORITY
```
    Deprecated. Use HIGH instead.
    
    See Also:
    
    Constant Field Values
  - NORMAL_PRIORITY
```
@Deprecated
public static final double NORMAL_PRIORITY
```
    Deprecated. Use NORMAL instead.
    
    See Also:
    
    Constant Field Values
  - LOW_PRIORITY
```
@Deprecated
public static final double LOW_PRIORITY
```
    Deprecated. Use LOW instead.
    
    See Also:
    
    Constant Field Values
  - VERY_LOW_PRIORITY
```
@Deprecated
public static final double VERY_LOW_PRIORITY
```
    Deprecated. Use VERY_LOW instead.
    
    See Also:
    
    Constant Field Values
  - LAST_PRIORITY
```
@Deprecated
public static final double LAST_PRIORITY
```
    Deprecated. Use LAST instead.
    
    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.

Class Priority

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIRST

EXTREMELY_HIGH

VERY_HIGH

HIGH

NORMAL

LOW

VERY_LOW

EXTREMELY_LOW

LAST

FIRST_PRIORITY

VERY_HIGH_PRIORITY

HIGH_PRIORITY

NORMAL_PRIORITY

LOW_PRIORITY

VERY_LOW_PRIORITY

LAST_PRIORITY

Method Detail

compare

inject