com.oracle.bedrock.junit.options

Class TestClasses

java.lang.Object

com.oracle.bedrock.junit.options.TestClasses

All Implemented Interfaces:

com.oracle.bedrock.Option, com.oracle.bedrock.Option.Collectable, Serializable

Direct Known Subclasses:

TestClasses.ClassPathClasses, TestClasses.SpecificClasses

public abstract class TestClasses
extends Object
implements com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option, Serializable

An option representing a set of test Classes.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestClasses.AlwaysRunFilter A JUnit test Filter that always matches everything.
protected static class	TestClasses.ClassPathClasses A TestClasses instance that resolves test classes from a specific ClassPath instance.
static class	TestClasses.IncludeExcludePredicate A Predicate that uses an inner predicate as well as this TestClasses include and exclude patterns to filter Class files.
static class	TestClasses.SpecificClasses A TestClasses instance that uses a fixed set of Classes as the set of tests to execute.
protected static class	TestClasses.TestFilter A JUnit test Filter that filters test Class names and method names based on the set of included and excluded TestClasses.TestMatchers.
protected static class	TestClasses.TestMatcher A class that matches a class and method name based on a pair of regular expressions.

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Constructor Summary

Constructors

Constructor and Description
TestClasses()

Method Summary

Modifier and Type	Method and Description
static TestClasses	empty() Create an empty set of test classes.
TestClasses	exclude(String... patterns) Add the specified regular expression pattern to the set of patterns to use to determine tests to be excluded in the test run.
static TestClasses	from(ClassPath classPath) Create a TestClasses option that will resolve test classes from the specified ClassPath.
Class<? extends com.oracle.bedrock.Option.Collector>	getCollectorClass()
protected Predicate<Class<?>>	getTestClassPredicate() Obtain the Predicate to use when resolving the list of classes to include in a test run.
org.junit.runner.manipulation.Filter	getTestFilter() Obtain the Filter instance to be used by the test run to determine tests that will be executed.
TestClasses	include(String... patterns) Add the specified regular expression pattern to the set of patterns to use to determine tests to be included in the test run.
static TestClasses	of(Class<?>... classes) Create a TestClasses option that will resolve test classes from the specified Class instances
abstract Set<Class<?>>	resolveTestClasses() Obtain the Set of Classes to test.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestClasses

public TestClasses()

Method Detail

resolveTestClasses

public abstract Set<Class<?>> resolveTestClasses()

Obtain the Set of Classes to test.

The classes returned will be determined by any include and exclude patterns.

Returns:

the Set of Classes to test

include

public TestClasses include(String... patterns)

Add the specified regular expression pattern to the set of patterns to use to determine tests to be included in the test run.

NOTE: The exclude patterns take precedence over the include patterns, so if a test matches both include and exclude then it is excluded.

Parameters:

patterns - the regular expressions to use to match tests included in the test run

Returns:

this TestClasses instance for method chaining

exclude

public TestClasses exclude(String... patterns)

Add the specified regular expression pattern to the set of patterns to use to determine tests to be excluded in the test run.

NOTE: The exclude patterns take precedence over the include patterns, so if a test matches both include and exclude then it is excluded.

Parameters:

patterns - the regular expressions to use to match tests included in the test run

Returns:

this TestClasses instance for method chaining

getTestFilter

public org.junit.runner.manipulation.Filter getTestFilter()

Obtain the Filter instance to be used by the test run to determine tests that will be executed.

Returns:

the Filter instance to be used by the test run to determine tests that will be executed

getTestClassPredicate

protected Predicate<Class<?>> getTestClassPredicate()

Obtain the Predicate to use when resolving the list of classes to include in a test run.

Returns:

the Predicate to use when resolving the list of classes to include in a test run

getCollectorClass

public Class<? extends com.oracle.bedrock.Option.Collector> getCollectorClass()

Specified by:

getCollectorClass in interface com.oracle.bedrock.Option.Collectable

of

public static TestClasses of(Class<?>... classes)

Create a TestClasses option that will resolve test classes from the specified Class instances

Parameters:

classes - the Classes to use to resolve test classes

Returns:

a TestClasses option that will resolve test classes from the specified Classes

from

public static TestClasses from(ClassPath classPath)

Create a TestClasses option that will resolve test classes from the specified ClassPath.

Parameters:

classPath - the ClassPath to use to resolve test classes

Returns:

a TestClasses option that will resolve test classes from the specified ClassPath

empty

@OptionsByType.Default
public static TestClasses empty()

Create an empty set of test classes.

Returns:

an empty set of test classes