Package org.eclipse.jface.viewers
Class StructuredSelection
- java.lang.Object
-
- org.eclipse.jface.viewers.StructuredSelection
-
- All Implemented Interfaces:
Iterable,ISelection,IStructuredSelection
- Direct Known Subclasses:
TreeSelection
public class StructuredSelection extends Object implements IStructuredSelection
A concrete implementation of theIStructuredSelectioninterface, suitable for instantiating.This class is not intended to be subclassed.
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Field Summary
Fields Modifier and Type Field Description static StructuredSelectionEMPTYThe canonical empty selection.
-
Constructor Summary
Constructors Constructor Description StructuredSelection()Creates a new empty selection.StructuredSelection(Object element)Creates a structured selection containing a single object.StructuredSelection(Object[] elements)Creates a structured selection from the given elements.StructuredSelection(List elements)Creates a structured selection from the givenList.StructuredSelection(List elements, IElementComparer comparer)Creates a structured selection from the givenListand element comparer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)Returns whether this structured selection is equal to the given object.ObjectgetFirstElement()Returns the first element in this selection, ornullif the selection is empty.inthashCode()booleanisEmpty()Returns whether this selection is empty.Iteratoriterator()Returns an iterator over the elements of this selection.intsize()Returns the number of elements selected in this selection.Object[]toArray()Returns the elements in this selection as an array.ListtoList()Returns the elements in this selection as aList.StringtoString()Internal method which returns a string representation of this selection suitable for debug purposes only.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Field Detail
-
EMPTY
public static final StructuredSelection EMPTY
The canonical empty selection. This selection should be used instead ofnull.
-
-
Constructor Detail
-
StructuredSelection
public StructuredSelection()
Creates a new empty selection. See also the static fieldEMPTYwhich contains an empty selection singleton.- See Also:
EMPTY
-
StructuredSelection
public StructuredSelection(Object[] elements)
Creates a structured selection from the given elements. The given element array must not benull.- Parameters:
elements- an array of elements
-
StructuredSelection
public StructuredSelection(Object element)
Creates a structured selection containing a single object. The object must not benull.- Parameters:
element- the element
-
StructuredSelection
public StructuredSelection(List elements)
Creates a structured selection from the givenList.- Parameters:
elements- list of selected elements
-
StructuredSelection
public StructuredSelection(List elements, IElementComparer comparer)
Creates a structured selection from the givenListand element comparer. If an element comparer is provided, it will be used to determine equality between structured selection objects provided that they both are based on the same (identical) comparer. See bug- Parameters:
elements- list of selected elementscomparer- the comparer, or null- Since:
- 3.4
-
-
Method Detail
-
equals
public boolean equals(Object o)
Returns whether this structured selection is equal to the given object. Two structured selections are equal if they contain the same elements in the same order.
-
getFirstElement
public Object getFirstElement()
Description copied from interface:IStructuredSelectionReturns the first element in this selection, ornullif the selection is empty.- Specified by:
getFirstElementin interfaceIStructuredSelection- Returns:
- an element, or
nullif none
-
isEmpty
public boolean isEmpty()
Description copied from interface:ISelectionReturns whether this selection is empty.- Specified by:
isEmptyin interfaceISelection- Returns:
trueif this selection is empty, andfalseotherwise
-
iterator
public Iterator iterator()
Description copied from interface:IStructuredSelectionReturns an iterator over the elements of this selection.- Specified by:
iteratorin interfaceIStructuredSelection- Specified by:
iteratorin interfaceIterable- Returns:
- an iterator over the selected elements
-
size
public int size()
Description copied from interface:IStructuredSelectionReturns the number of elements selected in this selection.- Specified by:
sizein interfaceIStructuredSelection- Returns:
- the number of elements selected
-
toArray
public Object[] toArray()
Description copied from interface:IStructuredSelectionReturns the elements in this selection as an array.- Specified by:
toArrayin interfaceIStructuredSelection- Returns:
- the selected elements as an array
-
toList
public List toList()
Description copied from interface:IStructuredSelectionReturns the elements in this selection as aList.- Specified by:
toListin interfaceIStructuredSelection- Returns:
- the selected elements as a list
-
-