org.eclipse.jdt.core.search
Interface IJavaSearchScope

public interface IJavaSearchScope

An IJavaSearchScope defines where search result should be found by a SearchEngine. Clients must pass an instance of this interface to the search(...) methods. Such an instance can be created using the following factory methods on SearchEngine: createHierarchyScope(IType), createJavaSearchScope(IResource[]), createWorkspaceScope(), or clients may choose to implement this interface.

Field Summary

static String

JAR_FILE_ENTRY_SEPARATOR This constant defines the separator of the resourcePath string of the encloses(String) method.

Method Summary

boolean	encloses(IJavaElement element) Checks whether this scope encloses the given element.
boolean	encloses(String resourcePath) Checks whether the resource at the given path is enclosed by this scope.
IPath[]	enclosingProjectsAndJars() Returns the paths to the enclosing projects and JARs for this search scope.
boolean	includesBinaries() Deprecated.
boolean	includesClasspaths() Deprecated.
void	setIncludesBinaries(boolean includesBinaries) Deprecated. Use SearchEngine.createJavaSearchScope(IJavaElement[]) with the package fragment roots that correspond to the binaries instead
void	setIncludesClasspaths(boolean includesClasspaths) Deprecated. Use SearchEngine.createJavaSearchScope(IJavaElement[]) with a java project instead

Field Detail

JAR_FILE_ENTRY_SEPARATOR

public static final String JAR_FILE_ENTRY_SEPARATOR

This constant defines the separator of the resourcePath string of the encloses(String) method. If present in the string, it separates the path to the jar file from the path to the .class file in the jar.

See Also:

Constant Field Values

Method Detail

encloses

public boolean encloses(String resourcePath)

Checks whether the resource at the given path is enclosed by this scope.

Parameters:

resourcePath - if the resource is contained in a JAR file, the path is composed of 2 paths separated by JAR_FILE_ENTRY_SEPARATOR: the first path is the full OS path to the JAR (if it is an external JAR), or the workspace relative IPath to the JAR (if it is an internal JAR), the second path is the path to the resource inside the JAR.

Returns:

whether the resource is enclosed by this scope

encloses

public boolean encloses(IJavaElement element)

Checks whether this scope encloses the given element.

Parameters:

element - the element

Returns:

true if the element is in this scope

enclosingProjectsAndJars

public IPath[] enclosingProjectsAndJars()

Returns the paths to the enclosing projects and JARs for this search scope.

Returns:

an array of paths to the enclosing projects and JARS. A project path is the full path to the project. A JAR path is the full OS path to the JAR file.

includesBinaries

public boolean includesBinaries()

Deprecated.

Returns whether this scope contains any .class files (either in folders or within JARs).

Returns:

whether this scope contains any .class files

includesClasspaths

public boolean includesClasspaths()

Deprecated.

Returns whether this scope includes classpaths defined by the projects of the resources of this search scope.

Returns:

whether this scope includes classpaths

setIncludesBinaries

public void setIncludesBinaries(boolean includesBinaries)

Deprecated. Use SearchEngine.createJavaSearchScope(IJavaElement[]) with the package fragment roots that correspond to the binaries instead

Sets whether this scope contains any .class files (either in folders or within JARs).

Parameters:

includesBinaries - whether this scope contains any .class files

setIncludesClasspaths

public void setIncludesClasspaths(boolean includesClasspaths)

Deprecated. Use SearchEngine.createJavaSearchScope(IJavaElement[]) with a java project instead

Sets whether this scope includes the classpaths defined by the projects of the resources of this search scope.

Returns:

includesClasspaths whether this scope includes classpaths