Module org.junit.platform.commons

Package org.junit.platform.commons.support

Enum Class SearchOption

java.lang.Object

java.lang.Enum<SearchOption>

org.junit.platform.commons.support.SearchOption

All Implemented Interfaces:

Serializable, Comparable<SearchOption>, java.lang.constant.Constable

@API(status=EXPERIMENTAL,
     since="1.8")
public enum SearchOption
extends Enum<SearchOption>

Search options for finding an annotation within a class hierarchy.

Since:

1.8

See Also:

DEFAULT, INCLUDE_ENCLOSING_CLASSES

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Search the inheritance hierarchy (i.e., the current class, implemented interfaces, and superclasses), but do not search on enclosing classes.
INCLUDE_ENCLOSING_CLASSES	Search the inheritance hierarchy as with the DEFAULT search option but also search the enclosing class hierarchy for inner classes (i.e., a non-static member classes).

Method Summary

Modifier and Type	Method	Description
static SearchOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final SearchOption DEFAULT

Search the inheritance hierarchy (i.e., the current class, implemented interfaces, and superclasses), but do not search on enclosing classes.

See Also:

Class.getSuperclass(), Class.getInterfaces()

INCLUDE_ENCLOSING_CLASSES

public static final SearchOption INCLUDE_ENCLOSING_CLASSES

Search the inheritance hierarchy as with the DEFAULT search option but also search the enclosing class hierarchy for inner classes (i.e., a non-static member classes).

Method Details

values

public static SearchOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null