|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.jdeveloper.java.locator.BaseClassLocator
oracle.jdeveloper.java.locator.ProjectClassLocator
public class ProjectClassLocator
The ProjectClassLocator
is an implementation of the JavaClassLocator
to locate classes for a Project instance.
Field Summary | |
---|---|
protected static boolean |
ALL_LIBRARIES Constant indicating all libraries |
protected static boolean |
EXPORTED_LIBRARIES Constant indicating we want only exported libraries. |
Fields inherited from class oracle.jdeveloper.java.locator.BaseClassLocator |
---|
EMPTY_COLLECTION, EMPTY_LOCATOR, EMPTY_STRING_ARRAY |
Method Summary | |
---|---|
void |
buildIndex() Instructs this class locator to start building its index for locating files. |
void |
buildIndexInterruptibly() Instructs this class locator to start building its index for locating files. |
protected static URLPath |
getAddedClassPathFor(Project project) Utility routine to fetch the added classpath for the given project. |
protected void |
getAllClasses(java.util.Collection<java.lang.String> out, ClassNameFilter filter) Fetch all of the top-level classes that are known by this locator. |
protected void |
getAllClassesInterruptibly(java.util.Collection<java.lang.String> out, ClassNameFilter filter) Get all of the top-level classes that are known by this locator. |
protected void |
getAllPackages(java.util.Collection<java.lang.String> out, PackageNameFilter filter) Fetch all of the full packges that are known by this locator. |
protected void |
getAllPackagesInterruptibly(java.util.Collection<java.lang.String> out, PackageNameFilter filter) Get all of the full packges that are known by this locator. |
protected void |
getClassesInPackage(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Fetch the list of top-level classes within the given package, adding them to the out collection provided. |
protected void |
getClassesInPackageInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Get the list of top-level classes within the package. |
java.net.URL |
getClassURL(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name. |
java.net.URL |
getClassURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name. |
static java.util.Collection |
getDependentsFor(Project project) Utility routine to fetch the dependents for the given project. |
protected static ProjectClassLocator |
getInstance(Project project) Get the class locator instance for a project. |
protected static ProjectClassLocator |
getInstanceInterruptibly(Project project) Get the class locator instance for a project. |
protected static Library |
getJDKFor(Project project) Utility routine to fetch the JDK for the given project. |
protected static Library[] |
getLibrariesFor(Project project, boolean exportsOnly) Utility routine to fetch the libraries for the given project. |
protected static URLPath |
getModuleConfigClassPathFor(Project project) Utility routine to fetch the module config classpath for the given project. |
java.net.URL |
getNonProjectSourceURL(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name. |
java.net.URL |
getNonProjectSourceURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name. |
protected static java.net.URL |
getOutputURLFor(Project project) Utility routine to fetch the output URL for the given project. |
protected void |
getPackages(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Fetch the list of subpackages within the given package, adding them to the out collection provided. |
protected void |
getPackagesInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Get the list of subpackages within the given package. |
java.net.URL |
getProjectSourceURL(java.lang.String fqClassName, boolean includeDependencies) Fetch the URL for the SourceFile for the given fully-qualified Java class name. |
java.net.URL |
getProjectSourceURLInterruptibly(java.lang.String fqClassName, boolean includeDependencies) Fetch the URL for the SourceFile for the given fully-qualified Java class name. |
java.net.URL |
getResourceURL(java.lang.String resourceName) Fetch the URL for the Java resource file given the resource name. |
static URLPath |
getSourcePathFor(Project project) Utility routine to fetch the source path for the given project. |
java.net.URL |
getSourceURL(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name. |
java.net.URL |
getSourceURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name. |
java.net.URL |
getURL(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name. |
java.net.URL |
getURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name. |
protected static void |
processDependenciesRecurse(Project project, java.util.List traversedList, java.util.List libraryList, java.util.List<oracle.jdeveloper.java.locator.DeploymentClassLocator.DeploymentPaths> deploymentList, URLPath sourcePath, URLPath classPath, boolean exportsOnly, boolean checkInterrupt) Utility routine which recursively processes a project's dependencies. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final boolean EXPORTED_LIBRARIES
protected static final boolean ALL_LIBRARIES
Method Detail |
---|
protected static ProjectClassLocator getInstance(Project project)
project
- the projectprotected static ProjectClassLocator getInstanceInterruptibly(Project project) throws java.lang.InterruptedException
project
- the projectjava.lang.InterruptedException
- if the calling thread is interrupted while creating the class locator instanceprotected static void processDependenciesRecurse(Project project, java.util.List traversedList, java.util.List libraryList, java.util.List<oracle.jdeveloper.java.locator.DeploymentClassLocator.DeploymentPaths> deploymentList, URLPath sourcePath, URLPath classPath, boolean exportsOnly, boolean checkInterrupt) throws java.lang.InterruptedException
project
- the project to process the paths and dependencies oftraversedList
- the list of projects that have already been traversedlibraryList
- the list of libraries that are part of the project or any of its dependentsdeploymentList
- the list of deployment profiles that the project depends onsourcePath
- the sourcepath of the project or any of its dependentsclassPath
- the classpath of the project or any of its dependentsexportsOnly
- whether to include only exported libraries (vs. all libraries)checkInterrupt
- whether to check for interruptionjava.lang.InterruptedException
- if the operation is interruptedpublic static java.util.Collection getDependentsFor(Project project)
project
- the projects to fetch the dependents forprotected static URLPath getAddedClassPathFor(Project project)
project
- the project to get the added classpath forprotected static URLPath getModuleConfigClassPathFor(Project project)
project
- the project to get the module config classpath forprotected static java.net.URL getOutputURLFor(Project project)
project
- the project to fetch the output url forpublic static URLPath getSourcePathFor(Project project)
project
- the project to fetch the source path forprotected static Library getJDKFor(Project project)
project
- the project to fetch the JDK forprotected static Library[] getLibrariesFor(Project project, boolean exportsOnly)
project
- the project to fetch the libraries forexportsOnly
- whether to include only exports, vs. all librariespublic void buildIndex()
public void buildIndexInterruptibly() throws java.lang.InterruptedException
JavaClassLocator2
buildIndexInterruptibly
in interface JavaClassLocator2
buildIndexInterruptibly
in class BaseClassLocator
java.lang.InterruptedException
- if the build is interruptedprotected void getPackages(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out)
getPackages
in class BaseClassLocator
packagePrefix
- the package prefix, i.e., "java.io"out
- the collection to add the packagesprotected void getPackagesInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) throws java.lang.InterruptedException
BaseClassLocator
getPackagesInterruptibly
in class BaseClassLocator
packagePrefix
- the package prefixout
- the collection where packages are addedjava.lang.InterruptedException
- if the operation is interruptedprotected void getClassesInPackage(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out)
getClassesInPackage
in class BaseClassLocator
packagePrefix
- the package prefix, i.e., "java.io"out
- the collection to add the class namesprotected void getClassesInPackageInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) throws java.lang.InterruptedException
BaseClassLocator
getClassesInPackageInterruptibly
in class BaseClassLocator
packagePrefix
- the package prefixout
- the collection where packages are addedjava.lang.InterruptedException
- if the operation is interruptedprotected void getAllClasses(java.util.Collection<java.lang.String> out, ClassNameFilter filter)
getAllClasses
in class BaseClassLocator
out
- the collection to add the fully-qualified class namesfilter
- the class name filter to useprotected void getAllClassesInterruptibly(java.util.Collection<java.lang.String> out, ClassNameFilter filter) throws java.lang.InterruptedException
BaseClassLocator
getAllClassesInterruptibly
in class BaseClassLocator
out
- the collection where fully qualified class names are addedfilter
- the class name filter to usejava.lang.InterruptedException
- if the operation is interruptedprotected void getAllPackages(java.util.Collection<java.lang.String> out, PackageNameFilter filter)
getAllPackages
in class BaseClassLocator
out
- the collection to add the full package namesfilter
- the pckage name filter to useprotected void getAllPackagesInterruptibly(java.util.Collection<java.lang.String> out, PackageNameFilter filter) throws java.lang.InterruptedException
BaseClassLocator
getAllPackagesInterruptibly
in class BaseClassLocator
out
- the collection where package names are addedfilter
- the package name filter to usejava.lang.InterruptedException
- if the operation is interruptedpublic java.net.URL getURL(java.lang.String fqClassName)
fqClassName
- the fully-qualified class name in dotted notation, i.e., java.util.Listpublic java.net.URL getURLInterruptibly(java.lang.String fqClassName) throws java.lang.InterruptedException
JavaClassLocator2
getURLInterruptibly
in interface JavaClassLocator2
getURLInterruptibly
in class BaseClassLocator
fqClassName
- the fully-qualified class name in dotted notation, i.e., java.util.Listjava.lang.InterruptedException
- if the operation is interruptedpublic java.net.URL getProjectSourceURL(java.lang.String fqClassName, boolean includeDependencies)
fqClassName
- the fully-qualified class name in dotted notationincludeDependencies
- include the projects depended on by this current projectpublic java.net.URL getProjectSourceURLInterruptibly(java.lang.String fqClassName, boolean includeDependencies) throws java.lang.InterruptedException
fqClassName
- the fully-qualified class name in dotted notationincludeDependencies
- include the projects depended on by this current projectjava.lang.InterruptedException
- if the operation is interruptedpublic java.net.URL getNonProjectSourceURL(java.lang.String fqClassName)
public java.net.URL getNonProjectSourceURLInterruptibly(java.lang.String fqClassName) throws java.lang.InterruptedException
java.lang.InterruptedException
- if the operation is interruptedpublic java.net.URL getSourceURL(java.lang.String fqClassName)
fqClassName
- the fully-qualified class name in dotted notationpublic java.net.URL getSourceURLInterruptibly(java.lang.String fqClassName) throws java.lang.InterruptedException
JavaClassLocator2
getSourceURLInterruptibly
in interface JavaClassLocator2
getSourceURLInterruptibly
in class BaseClassLocator
fqClassName
- the fully-qualified class name in dotted notationjava.lang.InterruptedException
- if the operation is interruptedpublic java.net.URL getClassURL(java.lang.String fqClassName)
fqClassName
- the fully-qualified class name in dotted notationpublic java.net.URL getClassURLInterruptibly(java.lang.String fqClassName) throws java.lang.InterruptedException
JavaClassLocator2
getClassURLInterruptibly
in interface JavaClassLocator2
getClassURLInterruptibly
in class BaseClassLocator
fqClassName
- the fully-qualified class name in dotted notationjava.lang.InterruptedException
- if the operation is interruptedpublic java.net.URL getResourceURL(java.lang.String resourceName)
resourceName
- the full name of the resource including any file extensions
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |