Class StructuredSelection

  • All Implemented Interfaces:
    ISelection, IStructuredSelection
    Direct Known Subclasses:
    TreeSelection

    public class StructuredSelection
    extends Object
    implements IStructuredSelection
    A concrete implementation of the IStructuredSelection interface, suitable for instantiating.

    This class is not intended to be subclassed.

    Restriction:
    This class is not intended to be subclassed by clients.
    • Field Detail

      • EMPTY

        public static final StructuredSelection EMPTY
        The canonical empty selection. This selection should be used instead of null.
    • Constructor Detail

      • StructuredSelection

        public StructuredSelection()
        Creates a new empty selection. See also the static field EMPTY which 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 be null.
        Parameters:
        elements - an array of elements
      • StructuredSelection

        public StructuredSelection​(Object element)
        Creates a structured selection containing a single object. The object must not be null.
        Parameters:
        element - the element
      • StructuredSelection

        public StructuredSelection​(List elements)
        Creates a structured selection from the given List.
        Parameters:
        elements - list of selected elements
      • StructuredSelection

        public StructuredSelection​(List elements,
                                   IElementComparer comparer)
        Creates a structured selection from the given List and 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 elements
        comparer - 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.
        Overrides:
        equals in class Object
        Parameters:
        o - the other object
        Returns:
        true if they are equal, and false otherwise
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isEmpty

        public boolean isEmpty()
        Description copied from interface: ISelection
        Returns whether this selection is empty.
        Specified by:
        isEmpty in interface ISelection
        Returns:
        true if this selection is empty, and false otherwise
      • size

        public int size()
        Description copied from interface: IStructuredSelection
        Returns the number of elements selected in this selection.
        Specified by:
        size in interface IStructuredSelection
        Returns:
        the number of elements selected
      • toString

        public String toString()
        Internal method which returns a string representation of this selection suitable for debug purposes only.
        Overrides:
        toString in class Object
        Returns:
        debug string