Package org.hansken.plugin.extraction.api

Enum Class SearchScope

java.lang.Object

java.lang.Enum<SearchScope>

org.hansken.plugin.extraction.api.SearchScope

All Implemented Interfaces:

Serializable, Comparable<SearchScope>, Constable

public enum SearchScope
extends Enum<SearchScope>

Scope options for scoping a search to an image or project level.

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
IMAGE	Searches will be limited to the traces in the same image that is being extracted.
PROJECT	Searches will be limited to the traces in the same project that is being extracted.

Method Summary

Modifier and Type	Method	Description
static SearchScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchScope[]	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

IMAGE

public static final SearchScope IMAGE

Searches will be limited to the traces in the same image that is being extracted.

PROJECT

public static final SearchScope PROJECT

Searches will be limited to the traces in the same project that is being extracted.

Method Details

values

public static SearchScope[] 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 SearchScope 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