org.netbeans.modules.refactoring.api
Class Scope

java.lang.Object
  org.netbeans.modules.refactoring.api.Scope

public final class Scope
extends Object

Scope is used to limit the WhereUsedQuery to a specific scope. Add an instance of this class to the context of the WhereUsedQuery to limit the scope. A custom scope can be any combination of source roots, folders and files.

Since:

1.18

See Also:

Context

Method Summary

static Scope	create(Collection<FileObject> sourceRoots, Collection<NonRecursiveFolder> folders, Collection<FileObject> files) Creates a new scope.
Set<FileObject>	getFiles() Get the files to include in the where used query.
Set<NonRecursiveFolder>	getFolders() Get the non recursive folders to include in the where used query.
Set<FileObject>	getSourceRoots() Get the source roots to include in the where used query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFiles

@NonNull
public Set<FileObject> getFiles()

Get the files to include in the where used query.

Returns:

an unmodifiable set of the files

getFolders

@NonNull
public Set<NonRecursiveFolder> getFolders()

Get the non recursive folders to include in the where used query.

Returns:

an unmodifiable set of the folders

getSourceRoots

@NonNull
public Set<FileObject> getSourceRoots()

Get the source roots to include in the where used query.

Returns:

an unmodifiable set of the source roots

create

@NonNull
public static Scope create(@NullAllowed
                                   Collection<FileObject> sourceRoots,
                                   @NullAllowed
                                   Collection<NonRecursiveFolder> folders,
                                   @NullAllowed
                                   Collection<FileObject> files)

Creates a new scope. A custom scope can be any combination of source roots, folders and files.

Parameters:

sourceRoots - the source roots to include in this scope

folders - the non recursive folders to include in this scope

files - the files to include in this scope