org.junit.platform.engine.discovery

Class DiscoverySelectors

java.lang.Object

org.junit.platform.engine.discovery.DiscoverySelectors

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

Collection of static factory methods for creating DiscoverySelectors.

Since:

1.0

See Also:

ClasspathRootSelector, ClasspathResourceSelector, ClassSelector, MethodSelector, PackageSelector

Method Summary

Modifier and Type	Method and Description
static ClassSelector	selectClass(Class<?> clazz) Create a ClassSelector for the supplied Class.
static ClassSelector	selectClass(String className) Create a ClassSelector for the supplied class name.
static ClasspathResourceSelector	selectClasspathResource(String classpathResourceName) Create a ClasspathResourceSelector for the supplied classpath resource name.
static List<ClasspathRootSelector>	selectClasspathRoots(Set<Path> directories) Create a list of ClasspathRootSelectors for the supplied directories.
static DirectorySelector	selectDirectory(File directory) Create a DirectorySelector for the supplied directory.
static DirectorySelector	selectDirectory(String path) Create a DirectorySelector for the supplied directory path.
static FileSelector	selectFile(File file) Create a FileSelector for the supplied file.
static FileSelector	selectFile(String path) Create a FileSelector for the supplied file path.
static MethodSelector	selectMethod(Class<?> javaClass, Method method) Create a MethodSelector for the supplied Class and Method.
static MethodSelector	selectMethod(Class<?> javaClass, String methodName) Create a MethodSelector for the supplied Class and method name.
static MethodSelector	selectMethod(Class<?> javaClass, String methodName, String methodParameterTypes) Create a MethodSelector for the supplied Class, method name, and method parameter types.
static MethodSelector	selectMethod(String fullyQualifiedMethodName) Create a MethodSelector for the supplied fully qualified method methodName.
static MethodSelector	selectMethod(String className, String methodName) Create a MethodSelector for the supplied class name and method name.
static MethodSelector	selectMethod(String className, String methodName, String methodParameterTypes) Create a MethodSelector for the supplied class name, method name, and method parameter types.
static List<DiscoverySelector>	selectNames(Collection<String> names) Deprecated. This method will be removed in 5.0 M4; use selectPackage(String), selectClass(String), or selectMethod(String) instead.
static PackageSelector	selectPackage(String packageName) Create a PackageSelector for the supplied package name.
static UniqueIdSelector	selectUniqueId(String uniqueId) Create a UniqueIdSelector for the supplied unique ID.
static UniqueIdSelector	selectUniqueId(UniqueId uniqueId) Create a UniqueIdSelector for the supplied UniqueId.
static UriSelector	selectUri(String uri) Create a UriSelector for the supplied URI.
static UriSelector	selectUri(URI uri) Create a UriSelector for the supplied URI.

Methods inherited from class java.lang.Object

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

Method Detail

selectUri

public static UriSelector selectUri(String uri)

Create a UriSelector for the supplied URI.

Parameters:

uri - the URI to select; never null or blank

See Also:

UriSelector, selectUri(URI), selectFile(String), selectFile(File), selectDirectory(String), selectDirectory(File)

selectUri

public static UriSelector selectUri(URI uri)

Create a UriSelector for the supplied URI.

Parameters:

uri - the URI to select; never null

See Also:

UriSelector, selectUri(String), selectFile(String), selectFile(File), selectDirectory(String), selectDirectory(File)

selectFile

public static FileSelector selectFile(String path)

Create a FileSelector for the supplied file path.

This method selects the file using the supplied path as is, without verifying if the file exists.

Parameters:

path - the path to the file to select; never null or blank

See Also:

FileSelector, selectFile(File), selectDirectory(String), selectDirectory(File)

selectFile

public static FileSelector selectFile(File file)

Create a FileSelector for the supplied file.

This method selects the file in its canonical form and throws a PreconditionViolationException if the file does not exist.

Parameters:

file - the file to select; never null

See Also:

FileSelector, selectFile(String), selectDirectory(String), selectDirectory(File)

selectDirectory

public static DirectorySelector selectDirectory(String path)

Create a DirectorySelector for the supplied directory path.

This method selects the directory using the supplied path as is, without verifying if the directory exists.

Parameters:

path - the path to the directory to select; never null or blank

See Also:

DirectorySelector, selectDirectory(File), selectFile(String), selectFile(File)

selectDirectory

public static DirectorySelector selectDirectory(File directory)

Create a DirectorySelector for the supplied directory.

This method selects the directory in its canonical form and throws a PreconditionViolationException if the directory does not exist.

Parameters:

directory - the directory to select; never null

See Also:

DirectorySelector, selectDirectory(String), selectFile(String), selectFile(File)

selectClasspathRoots

public static List<ClasspathRootSelector> selectClasspathRoots(Set<Path> directories)

Create a list of ClasspathRootSelectors 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:

ClasspathRootSelector

selectClasspathResource

public static ClasspathResourceSelector selectClasspathResource(String classpathResourceName)

Create a ClasspathResourceSelector for the supplied classpath resource name.

The name of a classpath resource must follow the semantics for resource paths as defined in ClassLoader.getResource(String).

If the supplied classpath resource name is prefixed with a slash (/), the slash will be removed.

Parameters:

classpathResourceName - the name of the classpath resource; never null or blank

See Also:

ClasspathResourceSelector, ClassLoader.getResource(String), ClassLoader.getResourceAsStream(String), ClassLoader.getResources(String)

selectPackage

public static PackageSelector selectPackage(String packageName)

Create a PackageSelector for the supplied package name.

The default package is represented by an empty string ("").

Parameters:

packageName - the package name to select; never null and never containing whitespace only

See Also:

PackageSelector

selectClass

public static ClassSelector selectClass(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(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(String fullyQualifiedMethodName)
                                   throws PreconditionViolationException

Create a MethodSelector for the supplied fully qualified method methodName.

The following formats are supported.

• [fully qualified class]#[methodName]
• [fully qualified class]#[methodName](parameter type list)
  • The parameter type list is a comma-separated list of fully qualified class names for the types of parameters accepted by the method.

Examples

Method	Fully Qualified Method Name
CharSequence.chars()	java.lang.String#chars
CharSequence.chars()	java.lang.String#chars()
String.equalsIgnoreCase(String)	java.lang.String#equalsIgnoreCase(java.lang.String)
String.substring(int, int)	java.lang.String#substring(int, int)

Parameters:

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

Throws:

PreconditionViolationException

See Also:

MethodSelector

selectMethod

public static MethodSelector selectMethod(String className,
                                          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(String className,
                                          String methodName,
                                          String methodParameterTypes)

Create a MethodSelector for the supplied class name, method name, and method parameter types.

The parameter types String is typically a comma-separated list of atomic types, fully qualified class names, or array types; however, the exact syntax depends on the underlying test engine.

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

methodParameterTypes - the method parameter types as a single string; never null or blank

See Also:

MethodSelector

selectMethod

public static MethodSelector selectMethod(Class<?> javaClass,
                                          String methodName)

Create a MethodSelector for the supplied Class and method name.

Parameters:

javaClass - 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(Class<?> javaClass,
                                          String methodName,
                                          String methodParameterTypes)

Create a MethodSelector for the supplied Class, method name, and method parameter types.

The parameter types String is typically a comma-separated list of atomic types, fully qualified class names, or array types; however, the exact syntax depends on the underlying test engine.

Parameters:

javaClass - 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

methodParameterTypes - the method parameter types as a single string; never null or blank

See Also:

MethodSelector

selectMethod

public static MethodSelector selectMethod(Class<?> javaClass,
                                          Method method)

Create a MethodSelector for the supplied Class and Method.

Parameters:

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

method - the method to select; never null

See Also:

MethodSelector

selectNames

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

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

Create a list of DiscoverySelectors for the supplied names.

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:

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(String uniqueId)

Create a UniqueIdSelector for the supplied unique ID.

Parameters:

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

See Also:

UniqueIdSelector