org.osivia.services.editor.common.model

Enum SearchScope

java.lang.Object

java.lang.Enum<SearchScope>

org.osivia.services.editor.common.model.SearchScope

All Implemented Interfaces:

Serializable, Comparable<SearchScope>

public enum SearchScope
extends Enum<SearchScope>

Documents search scopes enumeration.

Author:

Cédric Krommenhoek

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVERYWHERE Everywhere.
WORKSPACE Current workspace.

Field Summary

Fields

Modifier and Type	Field and Description
static SearchScope	DEFAULT Default search scope.

Method Summary

Modifier and Type	Method and Description
static SearchScope	fromId(String id) Get search scope from identifier.
String	getId()
String	getKey()
static SearchScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORKSPACE

public static final SearchScope WORKSPACE

Current workspace.

EVERYWHERE

public static final SearchScope EVERYWHERE

Everywhere.

Field Detail

DEFAULT

public static final SearchScope DEFAULT

Default search scope.

Method Detail

values

public static SearchScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchScope c : SearchScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static SearchScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

fromId

public static SearchScope fromId(String id)

Get search scope from identifier.

Parameters:

id - identifier

Returns:

search scope

getId

public String getId()

getKey

public String getKey()