org.junit.platform.engine.discovery

Class DiscoverySelectors

java.lang.Object

org.junit.platform.engine.discovery.DiscoverySelectors

@API(value=Experimental)
public final class DiscoverySelectors
extends java.lang.Object

Collection of static factory methods for creating DiscoverySelectors.

Since:

1.0

See Also:

ClasspathSelector, ClassSelector, MethodSelector, PackageSelector

Method Summary

Modifier and Type	Method and Description
static ClassSelector	selectClass(java.lang.Class<?> clazz) Create a ClassSelector for the supplied Class.
static ClassSelector	selectClass(java.lang.String className) Create a ClassSelector for the supplied class name.
static java.util.List<DiscoverySelector>	selectClasspathRoots(java.util.Set<java.io.File> directories) Create a list of ClasspathSelectors for the supplied directories.
static MethodSelector	selectMethod(java.lang.Class<?> clazz, java.lang.reflect.Method method) Create a MethodSelector for the supplied Class and Method.
static MethodSelector	selectMethod(java.lang.Class<?> clazz, java.lang.String methodName) Create a MethodSelector for the supplied Class and method name.
static MethodSelector	selectMethod(java.lang.String name) Create a MethodSelector for the supplied fully qualified method name.
static MethodSelector	selectMethod(java.lang.String className, java.lang.String methodName) Create a MethodSelector for the supplied class name and method name.
static DiscoverySelector	selectName(java.lang.String name) Deprecated. This method will be removed in 5.0 M3; use selectPackage(String), selectClass(String), or selectMethod(String) instead.
static java.util.List<DiscoverySelector>	selectNames(java.util.Collection<java.lang.String> names) Deprecated. This method will be removed in 5.0 M3; use selectPackage(String), selectClass(String), or selectMethod(String) instead.
static java.util.List<DiscoverySelector>	selectNames(java.lang.String... names) Deprecated. This method will be removed in 5.0 M3; use selectPackage(String), selectClass(String), or selectMethod(String) instead.
static PackageSelector	selectPackage(java.lang.String packageName) Create a PackageSelector for the supplied package name.
static UniqueIdSelector	selectUniqueId(java.lang.String uniqueId) Create a UniqueIdSelector for the supplied unique ID.
static UniqueIdSelector	selectUniqueId(UniqueId uniqueId) Create a UniqueIdSelector for the supplied UniqueId.

Methods inherited from class java.lang.Object

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

Method Detail

selectClasspathRoots

public static java.util.List<DiscoverySelector> selectClasspathRoots(java.util.Set<java.io.File> directories)

Create a list of ClasspathSelectors for the supplied directories.

Parameters:

directories - set of directories in the filesystem that represent classpath roots; never null

Returns:

a list of selectors for the supplied directories; directories which do not physically exist in the filesystem will be filtered out

See Also:

ClasspathSelector

selectPackage

public static PackageSelector selectPackage(java.lang.String packageName)

Create a PackageSelector for the supplied package name.

Parameters:

packageName - the package name to select; never null or blank

See Also:

PackageSelector

selectClass

public static ClassSelector selectClass(java.lang.Class<?> clazz)

Create a ClassSelector for the supplied Class.

Parameters:

clazz - the class to select; never null

See Also:

ClassSelector

selectClass

public static ClassSelector selectClass(java.lang.String className)

Create a ClassSelector for the supplied class name.

Parameters:

className - the fully qualified name of the class to select; never null or blank

See Also:

ClassSelector

selectMethod

public static MethodSelector selectMethod(java.lang.String name)
                                   throws PreconditionViolationException

Create a MethodSelector for the supplied fully qualified method name.

The supported format for a fully qualified method name is [fully qualified class name]#[methodName]. For example, the fully qualified name for the chars() method in java.lang.String is "java.lang.String#chars".

WARNING: Overloaded methods and methods that accept arguments are not currently supported.

Parameters:

name - the fully qualified name of the method to select; never null or blank

Throws:

PreconditionViolationException - if the supplied name is null, blank, or does not specify a unique method

See Also:

MethodSelector

selectMethod

public static MethodSelector selectMethod(java.lang.String className,
                                          java.lang.String methodName)

Create a MethodSelector for the supplied class name and method name.

Parameters:

className - the fully qualified name of the class in which the method is declared, or a subclass thereof; never null or blank

methodName - the name of the method to select; never null or blank

See Also:

MethodSelector

selectMethod

public static MethodSelector selectMethod(java.lang.Class<?> clazz,
                                          java.lang.String methodName)

Create a MethodSelector for the supplied Class and method name.

Parameters:

clazz - the class in which the method is declared, or a subclass thereof; never null

methodName - the name of the method to select; never null or blank

See Also:

MethodSelector

selectMethod

public static MethodSelector selectMethod(java.lang.Class<?> clazz,
                                          java.lang.reflect.Method method)

Create a MethodSelector for the supplied Class and Method.

Parameters:

clazz - the class in which the method is declared, or a subclass thereof; never null

method - the method to select; never null

See Also:

MethodSelector

selectName

@Deprecated
 @API(value=Deprecated)
public static DiscoverySelector selectName(java.lang.String name)
                                                                        throws PreconditionViolationException

Deprecated. This method will be removed in 5.0 M3; use selectPackage(String), selectClass(String), or selectMethod(String) instead.

Create a DiscoverySelector for the supplied name.

Supported Name Types

• package: fully qualified package name
• class: fully qualified class name
• method: fully qualified method name

The supported format for a fully qualified method name is [fully qualified class name]#[methodName]. For example, the fully qualified name for the chars() method in java.lang.String is java.lang.String#chars. Names for overloaded methods are not supported.

Parameters:

name - the name to select; never null or blank

Returns:

an instance of ClassSelector, MethodSelector, or PackageSelector

Throws:

PreconditionViolationException - if the supplied name is null, blank, or does not specify a class, method, or package

See Also:

selectPackage(String), selectClass(String), selectMethod(String)

selectNames

@Deprecated
 @API(value=Deprecated)
public static java.util.List<DiscoverySelector> selectNames(java.lang.String... names)

Deprecated. This method will be removed in 5.0 M3; use selectPackage(String), selectClass(String), or selectMethod(String) instead.

Create a list of DiscoverySelectors for the supplied names.

Consult the documentation for selectName(String) for details on what types of names are supported.

Parameters:

names - the names to select; never null

Returns:

a list of DiscoverySelectors for the supplied names; potentially empty

See Also:

selectPackage(String), selectClass(String), selectMethod(String)

selectNames

@Deprecated
 @API(value=Deprecated)
public static java.util.List<DiscoverySelector> selectNames(java.util.Collection<java.lang.String> names)

Deprecated. This method will be removed in 5.0 M3; use selectPackage(String), selectClass(String), or selectMethod(String) instead.

Create a list of DiscoverySelectors for the supplied names.

Consult the documentation for selectName(String) for details on what types of names are supported.

Parameters:

names - the names to select; never null

Returns:

a list of DiscoverySelectors for the supplied names; potentially empty

See Also:

selectPackage(String), selectClass(String), selectMethod(String)

selectUniqueId

public static UniqueIdSelector selectUniqueId(UniqueId uniqueId)

Create a UniqueIdSelector for the supplied UniqueId.

Parameters:

uniqueId - the UniqueId to select; never null

See Also:

UniqueIdSelector

selectUniqueId

public static UniqueIdSelector selectUniqueId(java.lang.String uniqueId)

Create a UniqueIdSelector for the supplied unique ID.

Parameters:

uniqueId - the unique ID to select; never null or blank

See Also:

UniqueIdSelector