Package org.junit.experimental.categories

Class Categories.CategoryFilter

java.lang.Object

org.junit.runner.manipulation.Filter

org.junit.experimental.categories.Categories.CategoryFilter

Direct Known Subclasses:

ExcludeCategories.ExcludesAny, IncludeCategories.IncludesAny

Enclosing class:

Categories

public static class Categories.CategoryFilter
extends Filter

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<java.lang.Class<?>>	excluded
private boolean	excludedAny
private java.util.Set<java.lang.Class<?>>	included
private boolean	includedAny

Fields inherited from class org.junit.runner.manipulation.Filter

ALL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CategoryFilter(boolean matchAnyIncludes, java.lang.Class<?>[] inclusions, boolean matchAnyExcludes, java.lang.Class<?>[] exclusions)
protected	CategoryFilter(boolean matchAnyIncludes, java.util.Set<java.lang.Class<?>> includes, boolean matchAnyExcludes, java.util.Set<java.lang.Class<?>> excludes)
	CategoryFilter(java.lang.Class<?> includedCategory, java.lang.Class<?> excludedCategory)	Deprecated.

Method Summary

Modifier and Type	Method	Description
private static java.util.Set<java.lang.Class<?>>	categories(Description description)
static Categories.CategoryFilter	categoryFilter(boolean matchAnyInclusions, java.util.Set<java.lang.Class<?>> inclusions, boolean matchAnyExclusions, java.util.Set<java.lang.Class<?>> exclusions)
private static java.util.Set<java.lang.Class<?>>	copyAndRefine(java.util.Set<java.lang.Class<?>> classes)
java.lang.String	describe()	Returns a textual description of this Filter
private static java.lang.Class<?>[]	directCategories(Description description)
static Categories.CategoryFilter	exclude(boolean matchAny, java.lang.Class<?>... categories)
static Categories.CategoryFilter	exclude(java.lang.Class<?> category)
static Categories.CategoryFilter	exclude(java.lang.Class<?>... categories)
private boolean	hasCorrectCategoryAnnotation(Description description)
static Categories.CategoryFilter	include(boolean matchAny, java.lang.Class<?>... categories)
static Categories.CategoryFilter	include(java.lang.Class<?> category)
static Categories.CategoryFilter	include(java.lang.Class<?>... categories)
private boolean	matchesAllParentCategories(java.util.Set<java.lang.Class<?>> childCategories, java.util.Set<java.lang.Class<?>> parentCategories)
private boolean	matchesAnyParentCategories(java.util.Set<java.lang.Class<?>> childCategories, java.util.Set<java.lang.Class<?>> parentCategories)
private static Description	parentDescription(Description description)
boolean	shouldRun(Description description)
java.lang.String	toString()	Returns string in the form "[included categories] - [excluded categories]", where both sets have comma separated names of categories.

Methods inherited from class org.junit.runner.manipulation.Filter

apply, intersect, matchMethodDescription

Methods inherited from class java.lang.Object

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

Field Detail

included

private final java.util.Set<java.lang.Class<?>> included

excluded

private final java.util.Set<java.lang.Class<?>> excluded

includedAny

private final boolean includedAny

excludedAny

private final boolean excludedAny

Constructor Detail

CategoryFilter

@Deprecated
public CategoryFilter(java.lang.Class<?> includedCategory,
                      java.lang.Class<?> excludedCategory)

Deprecated.

CategoryFilter

protected CategoryFilter(boolean matchAnyIncludes,
                         java.util.Set<java.lang.Class<?>> includes,
                         boolean matchAnyExcludes,
                         java.util.Set<java.lang.Class<?>> excludes)

CategoryFilter

private CategoryFilter(boolean matchAnyIncludes,
                       java.lang.Class<?>[] inclusions,
                       boolean matchAnyExcludes,
                       java.lang.Class<?>[] exclusions)

Method Detail

include

public static Categories.CategoryFilter include(boolean matchAny,
                                                java.lang.Class<?>... categories)

include

public static Categories.CategoryFilter include(java.lang.Class<?> category)

include

public static Categories.CategoryFilter include(java.lang.Class<?>... categories)

exclude

public static Categories.CategoryFilter exclude(boolean matchAny,
                                                java.lang.Class<?>... categories)

exclude

public static Categories.CategoryFilter exclude(java.lang.Class<?> category)

exclude

public static Categories.CategoryFilter exclude(java.lang.Class<?>... categories)

categoryFilter

public static Categories.CategoryFilter categoryFilter(boolean matchAnyInclusions,
                                                       java.util.Set<java.lang.Class<?>> inclusions,
                                                       boolean matchAnyExclusions,
                                                       java.util.Set<java.lang.Class<?>> exclusions)

describe

public java.lang.String describe()

Description copied from class: Filter

Returns a textual description of this Filter

Specified by:

describe in class Filter

Returns:

a textual description of this Filter

See Also:

toString()

toString

public java.lang.String toString()

Returns string in the form "[included categories] - [excluded categories]", where both sets have comma separated names of categories.

Overrides:

toString in class java.lang.Object

Returns:

string representation for the relative complement of excluded categories set in the set of included categories. Examples:

• "categories [all]" for all included categories and no excluded ones;
• "categories [all] - [A, B]" for all included categories and given excluded ones;
• "categories [A, B] - [C, D]" for given included categories and given excluded ones.

See Also:

name of category

shouldRun

public boolean shouldRun(Description description)

Specified by:

shouldRun in class Filter

Parameters:

description - the description of the test to be run

Returns:

true if the test should be run

hasCorrectCategoryAnnotation

private boolean hasCorrectCategoryAnnotation(Description description)

matchesAnyParentCategories

private boolean matchesAnyParentCategories(java.util.Set<java.lang.Class<?>> childCategories,
                                           java.util.Set<java.lang.Class<?>> parentCategories)

Returns:

true if at least one (any) parent category match a child, otherwise false. If empty parentCategories, returns false.

matchesAllParentCategories

private boolean matchesAllParentCategories(java.util.Set<java.lang.Class<?>> childCategories,
                                           java.util.Set<java.lang.Class<?>> parentCategories)

Returns:

false if at least one parent category does not match children, otherwise true. If empty parentCategories, returns true.

categories

private static java.util.Set<java.lang.Class<?>> categories(Description description)

parentDescription

private static Description parentDescription(Description description)

directCategories

private static java.lang.Class<?>[] directCategories(Description description)

copyAndRefine

private static java.util.Set<java.lang.Class<?>> copyAndRefine(java.util.Set<java.lang.Class<?>> classes)