org.cytoscape.work.util
Class ListSingleSelection<T>

java.lang.Object
  org.cytoscape.work.util.ListSingleSelection<T>

Type Parameters:

T - type of items that will be listed.

public final class ListSingleSelection<T>
extends Object

List with items of type T : only 1 item can be selected.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Field Summary

protected List<T>

values Declares a List of items of type T.

Constructor Summary

ListSingleSelection(List<T> values)
Creates a new ListSingleSelection object.

ListSingleSelection(T... values)
Creates a new ListSingleSelection object.

Method Summary

List<T>	getPossibleValues() To get all the items of the List values.
T	getSelectedValue() Get the item that is currently selected.
void	setSelectedValue(T val) Set the val item of type T as selected in the ListSingleSelection.

Methods inherited from class java.lang.Object

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

Field Detail

values

protected final List<T> values

Declares a List of items of type T.

Constructor Detail

ListSingleSelection

public ListSingleSelection(T... values)

Creates a new ListSingleSelection object.

 example :
 
 ListSingleSelection lss = new ListSingleSelection("1","2","3","4")
 

Parameters:

values - An arbitrary number of values of type T that can be selected.

ListSingleSelection

public ListSingleSelection(List<T> values)

Creates a new ListSingleSelection object.

example :


        List list = ArrayList();
        list.add("1");
        list.add("2");
        list.add("3");
        list.add("4");

        ListSingleSelection lss = new ListSingleSelection(list);

Parameters:

values - The list of values of type T that can be selected. This list may be empty, but not null.

Method Detail

getSelectedValue

public T getSelectedValue()

Get the item that is currently selected.

Returns:

the selected item.

setSelectedValue

public void setSelectedValue(T val)

Set the val item of type T as selected in the ListSingleSelection.

Parameters:

val - the selected item.

getPossibleValues

public List<T> getPossibleValues()

To get all the items of the List values.

Returns:

an enumeration of all the items.