org.netbeans.spi.search

Enum SearchFilterDefinition.FolderResult

java.lang.Object

java.lang.Enum<SearchFilterDefinition.FolderResult>

org.netbeans.spi.search.SearchFilterDefinition.FolderResult

All Implemented Interfaces:

Serializable, Comparable<SearchFilterDefinition.FolderResult>

Enclosing class:

SearchFilterDefinition

public static enum SearchFilterDefinition.FolderResult
extends Enum<SearchFilterDefinition.FolderResult>

Result of filtering a folder.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_NOT_TRAVERSE Constant representing answer "do not traverse the folder".
TRAVERSE Constant representing answer "traverse the folder".
TRAVERSE_ALL_SUBFOLDERS Constant representing answer "traverse the folder and all its direct and indirect children (both files and subfolders)".

Method Summary

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

DO_NOT_TRAVERSE

public static final SearchFilterDefinition.FolderResult DO_NOT_TRAVERSE

Constant representing answer "do not traverse the folder".

TRAVERSE

public static final SearchFilterDefinition.FolderResult TRAVERSE

Constant representing answer "traverse the folder".

TRAVERSE_ALL_SUBFOLDERS

public static final SearchFilterDefinition.FolderResult TRAVERSE_ALL_SUBFOLDERS

Constant representing answer "traverse the folder and all its direct and indirect children (both files and subfolders)".

Method Detail

values

public static SearchFilterDefinition.FolderResult[] 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 (SearchFilterDefinition.FolderResult c : SearchFilterDefinition.FolderResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static SearchFilterDefinition.FolderResult 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