org.modelio.api.ui.swt

Class SelectionHelper

java.lang.Object

org.modelio.api.ui.swt.SelectionHelper

public final class SelectionHelper
extends java.lang.Object

Helper class to manipulate ISelection objects.

All the methods check the selection is a IStructuredSelection. Selection objects not matching this criteria are treated as empty selections.

Since:

3.7.1

See Also:

ISelection, IStructuredSelection

Method Summary

Modifier and Type	Method and Description
static boolean	contains(ISelection selection, java.lang.Class<?> cls) Tells whether the selection contains at least one element of the given type.
static boolean	containsOnly(ISelection selection, java.lang.Class<?> cls) Tells whether the selection contains only elements of the given type.
static int	count(ISelection selection, java.lang.Class<?> cls) Count in the selection the elements matching the given type.
static <T> T	getFirst(ISelection selection, java.lang.Class<T> cls) Get the first element in the selection that matches the given type
static <T> java.util.List<T>	toList(ISelection selection, java.lang.Class<T> cls) Convert the selection object to a list of the given type.
static <T> java.util.stream.Stream<T>	toStream(ISelection selection, java.lang.Class<T> cls) Convert the selection object to a Stream of the given type.

Methods inherited from class java.lang.Object

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

Method Detail

contains

public static boolean contains(ISelection selection,
                               java.lang.Class<?> cls)

Tells whether the selection contains at least one element of the given type.

Returns false if the selection is empty.

Parameters:

selection - a selection object

cls - the required type

Returns:

true if the selection contains at least one such element.

containsOnly

public static boolean containsOnly(ISelection selection,
                                   java.lang.Class<?> cls)

Tells whether the selection contains only elements of the given type.

Returns false if the selection is empty.

Parameters:

selection - a selection object

cls - the required type

Returns:

true if the selection is not empty and contains only such elements.

count

public static int count(ISelection selection,
                        java.lang.Class<?> cls)

Count in the selection the elements matching the given type.

Parameters:

selection - a selection object

cls - the required type

Returns:

true the matching elements count.

toList

public static <T> java.util.List<T> toList(ISelection selection,
                                           java.lang.Class<T> cls)

Convert the selection object to a list of the given type.

All selection elements not matching the type are filtered out.

Type Parameters:

T - the wanted type

Parameters:

selection - the selection object

cls - the wanted type

Returns:

the filtered selection content

toStream

public static <T> java.util.stream.Stream<T> toStream(ISelection selection,
                                                      java.lang.Class<T> cls)

Convert the selection object to a Stream of the given type.

All selection elements not matching the type are filtered out.

Type Parameters:

T - the wanted type

Parameters:

selection - the selection object

cls - the wanted type

Returns:

the filtered selection content

getFirst

public static <T> T getFirst(ISelection selection,
                             java.lang.Class<T> cls)

Get the first element in the selection that matches the given type

Type Parameters:

T - the required type

Parameters:

selection - the selection object

cls - the required type class

Returns:

the first matching element or null.