org.jminor.common

Class Item<T>

java.lang.Object

org.jminor.common.Item<T>

Type Parameters:

T - the type of the value

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Item>

public final class Item<T>
extends java.lang.Object
implements java.lang.Comparable<Item>, java.io.Serializable

A class encapsulating a value and a caption representing the value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Item(T value) Instantiates a new Item, with the caption as item.toString() or an empty string in case of a null value
Item(T value, java.lang.String caption) Instantiates a new Item.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Item item) Compares this items caption with the caption of the given item
boolean	equals(java.lang.Object obj)
java.lang.String	getCaption()
T	getValue()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item(T value)

Instantiates a new Item, with the caption as item.toString() or an empty string in case of a null value

Parameters:

value - the value, may be null

Item

public Item(T value,
            java.lang.String caption)

Instantiates a new Item.

Parameters:

value - the value, may be null

caption - the caption

Throws:

java.lang.NullPointerException - if caption is null

Method Detail

getCaption

public java.lang.String getCaption()

Returns:

the caption

getValue

public T getValue()

Returns:

the value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the caption

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Item item)

Compares this items caption with the caption of the given item

Specified by:

compareTo in interface java.lang.Comparable<Item>

Parameters:

item - the item to compare with

Returns:

the compare result