oracle.jdeveloper.usage

Class UsageManager

java.lang.Object

oracle.jdeveloper.usage.UsageManager

public class UsageManager
extends java.lang.Object

The UsageManager is the main entry for the usage engine.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsageManager.ProjectPath Utility class that holds paths as a replacement for JProject for testing purposes.

Field Summary

Fields

Modifier and Type	Field and Description
protected UsageManager.ProjectPath	_projectPath The project path to use (instead of project).

Constructor Summary

Constructors

Constructor and Description
UsageManager(Project project) Fetch the usage manager instance for the given project.
UsageManager(UsageManager.ProjectPath projectPath) Fetch the usage manager instance for the given project path.

Method Summary

Methods

Modifier and Type	Method and Description
UsageQueryTask	findClassUsages(java.lang.String fqClassName, ClassUsageListener listener) Search for usages for the given class in the associated project's source path.
UsageQueryTask	findClassUsages(java.lang.String fqClassName, ClassUsageListener listener, java.net.URL[] urlsToSearch) Search for usages for the given class in the specified URLs only.
UsageQueryTask	findConstructorUsages(java.lang.String fqDeclareClassName, java.lang.String[] fqParameterTypeNames, ConstructorUsageListener listener) Search for usages for the given constructor in the associated project's source path.
UsageQueryTask	findConstructorUsages(java.lang.String fqDeclareClassName, java.lang.String[] fqParameterTypeNames, ConstructorUsageListener listener, java.net.URL[] urlsToSearch) Search for usages for the given field in the specified URLs only.
UsageQueryTask	findFieldUsages(java.lang.String fqDeclareClassName, java.lang.String fieldName, FieldUsageListener listener) Search for usages for the given field in the associated project's source path.
UsageQueryTask	findFieldUsages(java.lang.String fqDeclareClassName, java.lang.String fieldName, FieldUsageListener listener, java.net.URL[] urlsToSearch) Search for usages for the given field in the specified URLs only.
UsageQueryTask	findFieldUsages(java.lang.String fqDeclareClassName, java.lang.String fqFieldTypeName, java.lang.String fieldName, FieldUsageListener listener) Search for usages for the given field in the associated project's source path.
UsageQueryTask	findFieldUsages(java.lang.String fqDeclareClassName, java.lang.String fqFieldTypeName, java.lang.String fieldName, FieldUsageListener listener, java.net.URL[] urlsToSearch) Search for usages for the given field in the specified URLs only.
UsageQueryTask	findMethodUsages(java.lang.String fqDeclareClassName, java.lang.String methodName, java.lang.String[] fqParameterTypeNames, MethodUsageListener listener) Search for usages for the given method in the associated project's source path.
UsageQueryTask	findMethodUsages(java.lang.String fqDeclareClassName, java.lang.String methodName, java.lang.String[] fqParameterTypeNames, MethodUsageListener listener, java.net.URL[] urlsToSearch) Search for usages for the given field in the specified URLs only.
JavaClass	getClass(java.lang.String fqClassName) Fetch the JavaClass for the given class.
protected JavaFileProvider	getJavaProvider()
protected Project	getProject() Get the project.
protected UsageManager.ProjectPath	getProjectPath() Get the project path.

Methods inherited from class java.lang.Object

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

Field Detail

_projectPath

protected UsageManager.ProjectPath _projectPath

The project path to use (instead of project).

Constructor Detail

UsageManager

public UsageManager(Project project)

Fetch the usage manager instance for the given project.

Parameters:

project - the project context

UsageManager

public UsageManager(UsageManager.ProjectPath projectPath)

Fetch the usage manager instance for the given project path.

Parameters:

projectPath - the project path context

Method Detail

getJavaProvider

protected JavaFileProvider getJavaProvider()

getProject

protected Project getProject()

Get the project.

Returns:

the project

getProjectPath

protected UsageManager.ProjectPath getProjectPath()

Get the project path.

Returns:

the project path

findClassUsages

public UsageQueryTask findClassUsages(java.lang.String fqClassName,
                             ClassUsageListener listener)

Search for usages for the given class in the associated project's source path.

Parameters:

fqClassName - the fully-qualified class name

listener - the notification listener of class usage results

Returns:

the query task for checking the status of the query, or for cancelling the query

findClassUsages

public UsageQueryTask findClassUsages(java.lang.String fqClassName,
                             ClassUsageListener listener,
                             java.net.URL[] urlsToSearch)

Search for usages for the given class in the specified URLs only.

Parameters:

fqClassName - the fully-qualified class name

listener - the notification listener of class usage results

urlsToSearch - the list of urls to search through

Returns:

the query task for checking the status of the query, or for cancelling the query

findFieldUsages

public UsageQueryTask findFieldUsages(java.lang.String fqDeclareClassName,
                             java.lang.String fqFieldTypeName,
                             java.lang.String fieldName,
                             FieldUsageListener listener)

Search for usages for the given field in the associated project's source path.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

fqFieldTypeName - the fully-qualified name of the field type

fieldName - the field name

listener - the notification listener of field usage results

Returns:

the query task for checking the status of the query, or for cancelling the query

findFieldUsages

public UsageQueryTask findFieldUsages(java.lang.String fqDeclareClassName,
                             java.lang.String fieldName,
                             FieldUsageListener listener)

Search for usages for the given field in the associated project's source path.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

fieldName - the field name

listener - the notification listener of field usage results

Returns:

the query task for checking the status of the query, or for cancelling the query

findFieldUsages

public UsageQueryTask findFieldUsages(java.lang.String fqDeclareClassName,
                             java.lang.String fqFieldTypeName,
                             java.lang.String fieldName,
                             FieldUsageListener listener,
                             java.net.URL[] urlsToSearch)

Search for usages for the given field in the specified URLs only.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

fqFieldTypeName - the fully-qualified name of the field type

fieldName - the field name

listener - the notification listener of class usage results

urlsToSearch - the list of urls to search through

Returns:

the query task for checking the status of the query, or for cancelling the query

findFieldUsages

public UsageQueryTask findFieldUsages(java.lang.String fqDeclareClassName,
                             java.lang.String fieldName,
                             FieldUsageListener listener,
                             java.net.URL[] urlsToSearch)

Search for usages for the given field in the specified URLs only.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

fieldName - the field name

listener - the notification listener of class usage results

urlsToSearch - the list of urls to search through

Returns:

the query task for checking the status of the query, or for cancelling the query

findConstructorUsages

public UsageQueryTask findConstructorUsages(java.lang.String fqDeclareClassName,
                                   java.lang.String[] fqParameterTypeNames,
                                   ConstructorUsageListener listener)

Search for usages for the given constructor in the associated project's source path. The fully-qualified parameter type names should be provided, or a zero-length array if there are no parameters.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

fqParameterTypeNames - the fully-qualified names of the parameter types

listener - the notification listener of constructor usage results

Returns:

the query task for checking the status of the query, or for cancelling the query

findConstructorUsages

public UsageQueryTask findConstructorUsages(java.lang.String fqDeclareClassName,
                                   java.lang.String[] fqParameterTypeNames,
                                   ConstructorUsageListener listener,
                                   java.net.URL[] urlsToSearch)

Search for usages for the given field in the specified URLs only.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

fqParameterTypeNames - the fully-qualified names of the parameter types

listener - the notification listener of class usage results

urlsToSearch - the list of urls to search through

Returns:

the query task for checking the status of the query, or for cancelling the query

findMethodUsages

public UsageQueryTask findMethodUsages(java.lang.String fqDeclareClassName,
                              java.lang.String methodName,
                              java.lang.String[] fqParameterTypeNames,
                              MethodUsageListener listener)

Search for usages for the given method in the associated project's source path. The fully-qualified parameter type names should be provided, or a zero-length array if there are no parameters.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

methodName - the name of the method

fqParameterTypeNames - the fully-qualified names of the parameter types

listener - the notification listener of method usage results

Returns:

the query task for checking the status of the query, or for cancelling the query

findMethodUsages

public UsageQueryTask findMethodUsages(java.lang.String fqDeclareClassName,
                              java.lang.String methodName,
                              java.lang.String[] fqParameterTypeNames,
                              MethodUsageListener listener,
                              java.net.URL[] urlsToSearch)

Search for usages for the given field in the specified URLs only.

Parameters:

fqDeclareClassName - the fully-qualified name of the declaring class

methodName - the name of the method

fqParameterTypeNames - the fully-qualified names of the parameter types

listener - the notification listener of class usage results

urlsToSearch - the list of urls to search through

Returns:

the query task for checking the status of the query, or for cancelling the query

getClass

public JavaClass getClass(java.lang.String fqClassName)

Fetch the JavaClass for the given class.

Parameters:

fqClassName - the fully-qualified class name

Returns:

the JavaClass for the given fully-qualified class name