org.netbeans.api.java.source

Enum ClassIndex.SearchScope

java.lang.Object

java.lang.Enum<ClassIndex.SearchScope>

org.netbeans.api.java.source.ClassIndex.SearchScope

All Implemented Interfaces:

Serializable, Comparable<ClassIndex.SearchScope>, ClassIndex.SearchScopeType

Enclosing class:

ClassIndex

public static enum ClassIndex.SearchScope
extends Enum<ClassIndex.SearchScope>
implements ClassIndex.SearchScopeType

Default predefined ClassIndex.SearchScopeTypes

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEPENDENCIES Search is done in compile and boot path
SOURCE Search is done in source path

Method Summary

Methods

Modifier and Type	Method and Description
Set<? extends String>	getPackages() Limits search only into given packages.
static ClassIndex.SearchScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClassIndex.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

Methods inherited from interface org.netbeans.api.java.source.ClassIndex.SearchScopeType

isDependencies, isSources

Enum Constant Detail

SOURCE

public static final ClassIndex.SearchScope SOURCE

Search is done in source path

DEPENDENCIES

public static final ClassIndex.SearchScope DEPENDENCIES

Search is done in compile and boot path

Method Detail

values

public static ClassIndex.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 (ClassIndex.SearchScope c : ClassIndex.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 ClassIndex.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

getPackages

@CheckForNull
public Set<? extends String> getPackages()

Description copied from interface: ClassIndex.SearchScopeType

Limits search only into given packages.

Specified by:

getPackages in interface ClassIndex.SearchScopeType

Returns:

set of packages to search in or null which means all packages