Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotWorkArea

All Superinterfaces:
JotClassDatabase, JotElement, JotManipulations, Subject
All Known Subinterfaces:
JotModel
All Known Implementing Classes:
JotManager

public interface JotWorkArea
extends JotElement, JotManipulations

The JotWorkArea represents a group of compilation units, and/or sub-JotWorkAreas. It contains retrieval methods that operate within this work area's classpath or sourcepath scope. Work areas are parents of elements the contain.Work areas can be obtained by calling Jot.getWorkArea(String name).

This interface is not intended to be implemented by clients.


Field Summary
 
Fields inherited from interface oracle.ide.addin.Subject
OBJECT_MODIFIED
 
Method Summary
 void addChild(JotElement childElement)
          Adds the given JotElement as a child of this model.
 void addLibrary(JotLibrary library)
           
 java.lang.ClassLoader getClassLoader()
          Retrieves the ClassLoader associated with this JotWorkArea.
 JotFile getFile(java.lang.String filename)
          Retrieves the JotFile representing a specific file.
 JotFile getFile(java.net.URL url)
          Retrieves the JotFile representing a file located at a specific URL.
 java.util.Iterator getFileList(java.lang.String pkgName, int needs)
          Retrieves a list of classes available in a package
 JotLibrary getLibraryByName(java.lang.String libraryName)
           
 java.net.URL getURL(java.lang.String clsName, int needs)
          Retrieves the URL of the file containing the desired class.
 java.net.URL getURL(java.lang.String fileName, java.lang.String pkgName, int needs)
          Retrieves the URL of a specified file.
 java.lang.Class loadClass(java.lang.String className, boolean resolve)
          Loads a class from the JotWorkArea's classpath
 void removeChild(JotElement childElement)
          Removes the given JotElement from the list of children in this model.
 void removeLibrary(JotLibrary library)
           
 void removeLibraryByName(java.lang.String libraryName)
           
 void setLibraryList(JotLibrary[] libraryList)
           
 
Methods inherited from interface oracle.jdeveloper.jot.JotElement
getChildren, getContainedElements, getElementName, getElementType, getEndOffset, getID, getJotWorkArea, getParent, getStartOffset, isExistent, isReadOnly, isStructureKnown, setParent
 
Methods inherited from interface oracle.jdeveloper.jot.JotManipulations
copy, findAllFieldReferences, findAllFileReferences, findAllMethodReferences, findAllReferences, move
 
Methods inherited from interface oracle.jdeveloper.jot.JotClassDatabase
getAllClassDescriptors, getAllClassDescriptors, getClass, getClassList, getClassNameList, getJotTypeInfo, getPackage, getPackageList, getPackages, getType
 
Methods inherited from interface oracle.ide.addin.Subject
attach, detach, notifyObservers
 

Method Detail

loadClass

public java.lang.Class loadClass(java.lang.String className,
                                 boolean resolve)
                          throws java.lang.ClassNotFoundException
Loads a class from the JotWorkArea's classpath

Parameters:
resolve - whether to resolve the class once it is loaded.
Returns:
the java.lang.Class instance representing the class, or null if the class cannot be loaded.
Throws:
java.lang.ClassNotFoundException - if the class cannot be loaded.

getFile

public JotFile getFile(java.lang.String filename)
Retrieves the JotFile representing a specific file.

Parameters:
filename - the absolute path to the desired file.
Returns:
a JotFile representing the given file.

getFile

public JotFile getFile(java.net.URL url)
Retrieves the JotFile representing a file located at a specific URL.

Parameters:
url - the URL indicating the location of the file.
Returns:
a JotFile representing the given location.

getURL

public java.net.URL getURL(java.lang.String clsName,
                           int needs)
Retrieves the URL of the file containing the desired class.

Parameters:
clsName - the fully qualified class name.
needs - a description of what type of files to find - sources or class files.
Returns:
an URL representing the file containing the class, or null if it could not be found.

getURL

public java.net.URL getURL(java.lang.String fileName,
                           java.lang.String pkgName,
                           int needs)
Retrieves the URL of a specified file.

Parameters:
fileName - the name of the file (for example, Class1.java).
pkgName - the name of the package containing the file.
needs - whether to check the sourcepath or the classpath.
Returns:
an URL representing the file, or null if the file cannot be found.

getFileList

public java.util.Iterator getFileList(java.lang.String pkgName,
                                      int needs)
Retrieves a list of classes available in a package

Parameters:
pkgName - the name of the package for which files are requested.
needs - the type of classes to list: sourcepath classes, classpath classes, or both.
Returns:
an Iterator over the list of files. Each file is returned as an URL.
See Also:
#PREFER_SOURCE, #PREFER_CLASS, #NEED_SOURCE, #NEED_CLASS

getClassLoader

public java.lang.ClassLoader getClassLoader()
Retrieves the ClassLoader associated with this JotWorkArea.

Returns:
a ClassLoader that can be used to load classes based on the configuration associated with this JotManager.

addChild

public void addChild(JotElement childElement)
Adds the given JotElement as a child of this model.


removeChild

public void removeChild(JotElement childElement)
Removes the given JotElement from the list of children in this model.


setLibraryList

public void setLibraryList(JotLibrary[] libraryList)

getLibraryByName

public JotLibrary getLibraryByName(java.lang.String libraryName)

addLibrary

public void addLibrary(JotLibrary library)

removeLibrary

public void removeLibrary(JotLibrary library)

removeLibraryByName

public void removeLibraryByName(java.lang.String libraryName)

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.