Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.java/1 1.10.22
PREV NEXT | FRAMES NO FRAMES

# NetBeans Java Support APIs

JavaSupportAPIs The Java Support APIs provides basic facilities for getting or supplying information about Java-language source files.

See:
Description

Java Support APIs
org.netbeans.api.java.classpath | Representation of Java classpaths, and the ability to find the classpath needed for a particular purpose.
org.netbeans.api.java.queries | Java-specific queries.
org.netbeans.spi.java.classpath | SPI permitting new classpaths to be constructed and registered.
org.netbeans.spi.java.classpath.support | Convenience classes to make it easier to create classpaths.
org.netbeans.spi.java.queries | Implementations of Java-related queries.

JavaSupportAPIs The Java Support APIs provides basic facilities for getting or supplying information about Java-language source files. It is based on the query pattern so implementations can be supplied from other modules or projects.

### What is New (see all changes)?

- Nov 8 '04 UnitTestForSourceQuery supports multiple source and test roots

  Added two static methods, `findSources(FileObject)` and `findUnitTests(FileObject)`, into `UnitTestForSourceQuery`. Added a new SPI interface `MultipleRootsUnitTestForSourceQueryImplementation` which allows to a project type to return more than one source/test root. The change was required to allow support of multiple source and test roots.

- Apr 27 '04 Added SourceLevelQuery

  Added query answering the source level of a Java file.

- Mar 16 '04 `ClassPath` API changed to be pluggable and better support build system

  `ClassPath` is now final, not abstract. (Not incompatible, since the constructor was never public.) Same for `ClassPath.Entry`.

  `getClassPath` now looks for `ClassPathProvider`s rather than delegating to the filesystems mounted in `Repository`.

  The classpath type `DEBUG` was deprecated. `SOURCE` and `BOOT` were added.

  `ClassPath.Entry.getURL()` was added.

  There is a complete SPI for creating `ClassPath` instances.

- Mar 16 '04 Added `GlobalPathRegistry`

  Added a new class `GlobalPathRegistry` to represent classpaths of current interest, typically from open projects.

- Mar 16 '04 Added several queries

  Several new queries were added (API and SPI) to represent various aspects of Java sources.

### Use Cases

The API is widely used by all sorts of IDE modules which need to work with Java sources. They can obtain the classpath or boot classpath for a file (if there is one), find out where its source root is, find sources corresponding to bytecode class files, find all sources or classpaths corresponding to open projects, find Javadoc, etc. The SPI is intended mainly for Java platform and library providers, and project type providers, to declare all of this information.

### Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

##### Group of java interfaces

Interface Name | In/Out | Stability | Specified in What Document?
JavaSupportAPIs | Exported | Official | The Java Support APIs provides basic facilities for getting or supplying information about Java-language source files. It is based on the query pattern so implementations can be supplied from other modules or projects.

### Implementation Details

##### What do other modules need to do to declare a dependency on this one?

       OpenIDE-Module-Module-Dependencies: org.netbeans.api.java/1 > 1.10.22

Read more about the implementation in the answers to architecture questions.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.java/1 1.10.22
PREV NEXT | FRAMES NO FRAMES

Built on December 7 2006. | Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.