org.openstreetmap.josm.gui.tagging.ac

Class AutoCompletionItemPriority

java.lang.Object

org.openstreetmap.josm.gui.tagging.ac.AutoCompletionItemPriority

All Implemented Interfaces:

java.lang.Comparable<AutoCompletionItemPriority>

public class AutoCompletionItemPriority
extends java.lang.Object
implements java.lang.Comparable<AutoCompletionItemPriority>

Describes the priority of an item in an autocompletion list. The selected flag is currently only used in plugins. Instances of this class are not modifiable.

Since:

1762

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inDataSet
private boolean	inStandard
static AutoCompletionItemPriority	IS_IN_DATASET Indicates that this is an arbitrary value from the data set, i.e.
static AutoCompletionItemPriority	IS_IN_SELECTION Indicates that this is a value from a selected object.
static AutoCompletionItemPriority	IS_IN_STANDARD Indicates that this is a standard value, i.e.
static AutoCompletionItemPriority	IS_IN_STANDARD_AND_IN_DATASET Indicates, that the value is standard and it is found in the data.
private static int	NO_USER_INPUT
private boolean	selected
static AutoCompletionItemPriority	UNKNOWN Unknown priority.
private int	userInput

Constructor Summary

Constructors

Constructor and Description
AutoCompletionItemPriority(boolean inDataSet, boolean inStandard, boolean selected) Constructs a new AutoCompletionItemPriority.
AutoCompletionItemPriority(boolean inDataSet, boolean inStandard, boolean selected, java.lang.Integer userInput) Constructs a new AutoCompletionItemPriority.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AutoCompletionItemPriority other) Imposes an ordering on the priorities.
java.lang.Integer	getUserInput() Returns a number when the tag key / value has been entered by the user before.
boolean	isInDataSet() Determines if the item is found in the currently active data layer.
boolean	isInStandard() Determines if the item is a standard tag, e.g.
boolean	isSelected() Determines if it is found on an object that is currently selected.
AutoCompletionItemPriority	mergeWith(AutoCompletionItemPriority other) Merges two priorities.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

IS_IN_STANDARD_AND_IN_DATASET

public static final AutoCompletionItemPriority IS_IN_STANDARD_AND_IN_DATASET

Indicates, that the value is standard and it is found in the data. This has higher priority than some arbitrary standard value that is usually not used by the user.

IS_IN_DATASET

public static final AutoCompletionItemPriority IS_IN_DATASET

Indicates that this is an arbitrary value from the data set, i.e. the value of a tag name=*.

IS_IN_STANDARD

public static final AutoCompletionItemPriority IS_IN_STANDARD

Indicates that this is a standard value, i.e. a standard tag name or a standard value for a given tag name (from the presets).

IS_IN_SELECTION

public static final AutoCompletionItemPriority IS_IN_SELECTION

Indicates that this is a value from a selected object.

UNKNOWN

public static final AutoCompletionItemPriority UNKNOWN

Unknown priority. This is the lowest priority.

NO_USER_INPUT

private static final int NO_USER_INPUT

See Also:

Constant Field Values

userInput

private final int userInput

inDataSet

private final boolean inDataSet

inStandard

private final boolean inStandard

selected

private final boolean selected

Constructor Detail

AutoCompletionItemPriority

public AutoCompletionItemPriority(boolean inDataSet,
                                  boolean inStandard,
                                  boolean selected,
                                  java.lang.Integer userInput)

Constructs a new AutoCompletionItemPriority.

Parameters:

inDataSet - true, if the item is found in the currently active data layer

inStandard - true, if the item is a standard tag, e.g. from the presets

selected - true, if it is found on an object that is currently selected

userInput - null, if the user hasn't entered this tag so far. A number when the tag key / value has been entered by the user before. A lower number means this happened more recently and beats a higher number in priority.

AutoCompletionItemPriority

public AutoCompletionItemPriority(boolean inDataSet,
                                  boolean inStandard,
                                  boolean selected)

Constructs a new AutoCompletionItemPriority.

Parameters:

inDataSet - true, if the item is found in the currently active data layer

inStandard - true, if the item is a standard tag, e.g. from the presets

selected - true, if it is found on an object that is currently selected

Method Detail

isInDataSet

public boolean isInDataSet()

Determines if the item is found in the currently active data layer.

Returns:

true if the item is found in the currently active data layer

isInStandard

public boolean isInStandard()

Determines if the item is a standard tag, e.g. from the presets.

Returns:

true if the item is a standard tag, e.g. from the presets

isSelected

public boolean isSelected()

Determines if it is found on an object that is currently selected.

Returns:

true if it is found on an object that is currently selected

getUserInput

public java.lang.Integer getUserInput()

Returns a number when the tag key / value has been entered by the user before. A lower number means this happened more recently and beats a higher number in priority.

Returns:

a number when the tag key / value has been entered by the user before. null, if the user hasn't entered this tag so far.

compareTo

public int compareTo(AutoCompletionItemPriority other)

Imposes an ordering on the priorities. Currently, being in the current DataSet is worth more than being in the Presets.

Specified by:

compareTo in interface java.lang.Comparable<AutoCompletionItemPriority>

mergeWith

public AutoCompletionItemPriority mergeWith(AutoCompletionItemPriority other)

Merges two priorities. The resulting priority is always >= the original ones.

Parameters:

other - other priority

Returns:

the merged priority

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object