org.orbisgis.sif.common

Class ContainerItem<Key>

java.lang.Object

org.orbisgis.sif.common.ContainerItem<Key>

All Implemented Interfaces:

Serializable, Comparable<ContainerItem>

Direct Known Subclasses:

ContainerItemProperties

public class ContainerItem<Key>
extends Object
implements Serializable, Comparable<ContainerItem>

A tuple that hold a Key and a Label (localised).

Author:

Nicolas Fortin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_LABEL
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ContainerItem(Key key, String label) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Add a property-change listener for all properties.
void	addPropertyChangeListener(String prop, PropertyChangeListener listener) Add a property-change listener for a specific property.
int	compareTo(ContainerItem s)
boolean	equals(Object obj) The equal is done on the KEY internal name.
Key	getKey()
String	getLabel() Get the I18N GUI label
int	hashCode() Compute hashcode for the item
void	removePropertyChangeListener(PropertyChangeListener listener) Remove the specified listener from the list
void	removePropertyChangeListener(String prop, PropertyChangeListener listener) Remove the specified listener for a specified property from the list
void	setLabel(String label) Set the I18N GUI label
String	toString() The GUI representation of the item

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

PROP_LABEL

public static final String PROP_LABEL

See Also:

Constant Field Values

Constructor Detail

ContainerItem

public ContainerItem(Key key,
             String label)

Constructor

Parameters:

label - The I18N label of the Item, shown in the GUI

key - The internal name of this item, retrieved by listeners for processing

Throws:

IllegalArgumentException - if one of the arguments are missing

Method Detail

getKey

public Key getKey()

Returns:

The internal name of this item

compareTo

public int compareTo(ContainerItem s)

Specified by:

compareTo in interface Comparable<ContainerItem>

getLabel

public String getLabel()

Get the I18N GUI label

Returns:

the I18N GUI label

setLabel

public void setLabel(String label)

Set the I18N GUI label

Parameters:

label - the I18N GUI label

toString

public String toString()

The GUI representation of the item

Overrides:

toString in class Object

Returns:

String GUI representation of the item

equals

public boolean equals(Object obj)

The equal is done on the KEY internal name.

Overrides:

equals in class Object

Parameters:

obj - Other item of the list

Returns:

hashCode

public int hashCode()

Compute hashcode for the item

Overrides:

hashCode in class Object

Returns:

Hash code

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property-change listener for all properties. The listener is called for all properties.

Parameters:

listener - The PropertyChangeListener instance

addPropertyChangeListener

public void addPropertyChangeListener(String prop,
                             PropertyChangeListener listener)

Add a property-change listener for a specific property. The listener is called only when there is a change to the specified property.

Parameters:

prop - The static property name PROP_..

listener - The PropertyChangeListener instance

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove the specified listener from the list

Parameters:

listener - The listener instance

removePropertyChangeListener

public void removePropertyChangeListener(String prop,
                                PropertyChangeListener listener)

Remove the specified listener for a specified property from the list

Parameters:

prop - The static property name PROP_..

listener - The listener instance