Overview (Java Support APIs) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.api.java/1 1.13

PREV NEXT

FRAMES NO FRAMES

Java Support APIs
Official

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.

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)?

Mar 1 '07 Support for specifying classpath inclusion

Classpath implementations can now specify which files and folders/packages to include or exclude. (This could be used for binary classpaths such as COMPILE but currently only excludes on SOURCE paths are honored by Java language features.)
Feb 8 '07 BinaryForSourceQuery returns folder(s) containing binaries for source rooot

The new API BinaryForSourceQuery was added to allow clients to find out the output (class files) corresponding to source root. The query uses instances of a SPI interface BinaryForSourceQueryImplementation registered in the system lookup to find out the binaries. When no binary is found it uses the default algorithm (SFBQ.findSources(ClassPath.EXECUTE) == sourceRoot)
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 ClassPathProviders 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, in addition to or instead of a plain module dependency?

Nothing.

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