org.openstreetmap.josm.gui.tagging.ac

Class AutoCompletionListItem

java.lang.Object

org.openstreetmap.josm.gui.tagging.ac.AutoCompletionListItem

All Implemented Interfaces:

java.lang.Comparable<AutoCompletionListItem>

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

Represents an entry in the list of auto completion values. An AutoCompletionListItem has a priority and a value. The priority helps to sort the auto completion items according to their importance. For instance, in an auto completion list for tag names, standard tag names would be assigned a higher priority than arbitrary tag names present in the current data set. There are three priority levels, AutoCompletionItemPriority. The value is a string which will be displayed in the auto completion list.

Field Summary

Fields

Modifier and Type	Field and Description
private AutoCompletionItemPriority	priority the pritority of this item
private java.lang.String	value the value of this item

Constructor Summary

Constructors

Constructor and Description
AutoCompletionListItem() Constructs a new AutoCompletionListItem.
AutoCompletionListItem(java.lang.String value) Constructs a new AutoCompletionListItem with the given value and unknown priority.
AutoCompletionListItem(java.lang.String value, AutoCompletionItemPriority priority) Constructs a new AutoCompletionListItem with the given value and priority.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AutoCompletionListItem other)
boolean	equals(java.lang.Object obj)
AutoCompletionItemPriority	getPriority() Returns the priority.
java.lang.String	getValue() Returns the value.
int	hashCode()
void	setPriority(AutoCompletionItemPriority priority) Sets the priority.
void	setValue(java.lang.String value) sets the value
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

priority

private AutoCompletionItemPriority priority

the pritority of this item

value

private java.lang.String value

the value of this item

Constructor Detail

AutoCompletionListItem

public AutoCompletionListItem(java.lang.String value,
                              AutoCompletionItemPriority priority)

Constructs a new AutoCompletionListItem with the given value and priority.

Parameters:

value - The value

priority - The priority

AutoCompletionListItem

public AutoCompletionListItem(java.lang.String value)

Constructs a new AutoCompletionListItem with the given value and unknown priority.

Parameters:

value - The value

AutoCompletionListItem

public AutoCompletionListItem()

Constructs a new AutoCompletionListItem.

Method Detail

getPriority

public AutoCompletionItemPriority getPriority()

Returns the priority.

Returns:

the priority

setPriority

public void setPriority(AutoCompletionItemPriority priority)

Sets the priority.

Parameters:

priority - the priority

getValue

public java.lang.String getValue()

Returns the value.

Returns:

the value

setValue

public void setValue(java.lang.String value)

sets the value

Parameters:

value - the value; must not be null

Throws:

java.lang.IllegalArgumentException - thrown, if value if null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(AutoCompletionListItem other)

Specified by:

compareTo in interface java.lang.Comparable<AutoCompletionListItem>