NetBeans API List

Current Development Version

7 Nov 2009

This document provides a list of NetBeans APIs with a short description of what they are used for, and a table describing different types of interfaces (see What is an API? to understand why we list DTDs, file formats, etc.) and with a stability category (stable and official, under development, deprecated, friend or private; see API life-cycle for more info). The aim is to provide as detailed a definition of NetBeans module external interfaces as possible and give other developers a chance to decide whether they want to depend on a particular API or not.

Some of these APIs are part of the NetBeans Platform (for example lookup, loaders, utilities, nodes, explorer, window systems, multiview, etc.), some of them are specific to NetBeans IDE (projects, javacore, diff, etc.) and some are not included in the release at all and are just provided for download (usually via autoupdate). Basically when building an application based on NetBeans one is free to choose the set of modules and their APIs to satisfy one's needs.

This is a list of APIs for development version, if you want to see a list of APIs for a particular version, you may want to go to:

6.7 - Javadoc as released for NetBeans IDE 6.7
6.5 - Javadoc as released for NetBeans IDE 6.5
6.1 - Javadoc as released for NetBeans IDE 6.1
6.0 - Javadoc as released for NetBeans IDE 6.0
5.5.1 - Javadoc as released for NetBeans IDE 5.5.1
5.5 - Javadoc as released for NetBeans IDE 5.5
5.0 - Javadoc as released for NetBeans IDE 5.0

To get the API of your module listed here, see the documentation for the Javadoc building infrastructure.

Additional Sources of Information

FAQ and Mailing List

Can't find what you're looking for? Try the FAQ and then dev@openide.netbeans.org.

Content

Actions APIs - Actions provides system of support and utility classes for 'actions' usage in NetBeans.
Ant - The Ant integration module recognizes Ant build scripts, facilitates editing them as text or structurally, lets the user run targets or create shortcuts to them, etc.
Ant-Based Project Support - Provides the basic infrastructure by which Ant-based projects can be created, read and write configuration parameters and properties from/to disk, satisfy common queries and interfaces, etc.
Auto Update Services - org.netbeans.api.autoupdate org.netbeans.spi.autoupdate .
Bootstrap - The NetBeans launcher starts the application.
Classfile Reader - The ClassFile API is designed as a fast, low memory-cost way to access classfile information.
Classpath APIs - Models basic aspects of the metadata surrounding list of source roots, such as the classpath.
Command Line Parsing API - GetOpts like infrastructure to parse command line arguments with the cooperative participation of various modules.
Common Annotations - Provides common annotations serving as a documentation element and for static code analysis.
Common Palette - The project implements a new component palette that will be reused by other projects.
Common Server - Allows UI presentation of server instance without dependency on a server specific API (like j2eeserver).
Compatibility APIs - XXX no answer for arch-what .
Core - IDE - core.ide .
Database Explorer - This project provides access to objects defined in the Database Explorer.
Datasystems API - In summary, the LoadersAPI is responsible for scanning files in a directory on disk, weeding out irrelevant files of no interest to the IDE, and grouping the rest into logical chunks, or just determining what type of data each represents.
Debugger Core API - The debuggercore/api module (Debugger Core API) allows to install different debugger implementation to one IDE.
Debugger Core - UI - The debuggercore module (Debugger Core UI) contains shared UI components for all debugger implementations, and defines some SPI for sharing of them.
Dialogs API - The DialogsAPI allows creating a user notification, a dialog's description and also permits it to be displayed.
Diff - The diff module provides the ability to visualize differencies between source files.
Editor Braces Matching - The Braces Matching SPI allows modules providing editor support for documents to create their own BracesMatchers that are tailored for the type of documents they support.
Editor Code Completion - Code Completion provides users with a list of suggested completions for partially typed texts in the editor and various dialog input fields.
Editor Code Folding - The Code Folding is part of the editor module functionality and it's responsible for hiding of the portions of the code that are less important for the user at the given time.
Editor Code Templates - Code Templates allow to paste various code snippets by using parametrized text.
Editor Error Stripe - The Error Stripe shows an overview of important information of an edited source code.
Editor Guarded Sections - Guarded Sections protects user from modifying document content.
Editor Hints - XXX no answer.
Editor Indentation - Editor indentation performs reindentation and code beautification of Swing document.
Editor Library - The editor library module provides subset of editor functionality independent on the NetBeans IDE (except few specific standalone classes).
Editor Library 2 - The Editor Library 2 module is a set of official APIs and SPIs, designed to replaces the original Editor Library with legacy APIs that are not properly structured and do not conform to the rules implied on the current NB APIs.
Editor Module - The editor module provides a full-featured source text editor that is integrated with the Form Editor, Explorer, compiler, and debugger.
Editor Settings - The legacy settings system in the editor module is complicated, error prone and hard to use.
Editor Settings Storage - The module is an implementation of the org.netbeans.modules.editor.settings providing a settings storage on the default filesystem.
Editor Utilities - Editor Utilities module contains useful utility classes and methods used by other editor related modules.
ETable and Outline - XXX no answer for arch-what .
Execution API - The IDE uses a small interface to describe the execution of Java-based classes together with arguments.
Explorer & Property Sheet API - The ExplorerAPI is build around Explorer - solely a user-interface device: it has no particular knowledge of the structure of the IDE.
External Execution Support - Provides common APIs to execute external process in the IDE to handle its streams and present the output to the user.
External Libraries - Permits libraries to be defined, customized, and stored by the user for reuse in multiple projects.
File System API - The Filesystems API provides a common API to access files in a uniform manner.
General Queries API - General kinds of queries between modules.
I/O APIs - The Input/Output API is a small API module which contains InputOutput and related interfaces used in driving the Output Window.
J2EE DD API - The project is based on the requirement to access all J2ee deployment descriptor files for other Netbeans modules in a simple and J2EE spec.-independant way.
Java EE Metadata - The project provides a generic framework for accessing Java EE metadata models.
Java EE Server Registry - J2EE Server Module provides support for development of J2EE modules and framework for J2EE server management and for J2EE deployment in IDE.
JavaHelp Integration - The JavaHelp integration API wraps the standard JavaHelp extension library.
Java Platform - Many Java-based project types need to be able to configure the version and location of Java to be used when building and running the project.
Java Project Support - Provides support infrastructure for projects working with the Java language.
Java Refactoring - XXX no answer for arch-what .
Java SE Projects - Provides a project type for plain Java projects.
Java Source - XXX no answer for arch-what .
Java Source UI - java.sourceui .
Java Support APIs - Provides java specific queries (javadc, source level) used by other modules like java language infrastructure.
JPDA Debugger API - The debuggerjpda/api (Debugger JPDA API) defines API for NetBeans Java Debugger.
JUnit Tests - The module makes creating, running and navigation between tests easier.
Lexer - Lexer module provides token lists for various text inputs.
Look & Feel Customization Library - The plaf library consists primarily of code that used to be in core.
Master Filesystem - MasterFileSystems is just implementation of FileSystem provided in standalone module including implementation of URLMapper that resolves file protocol and is responsible for conversion from URL into FileObject and vice versa.
MIME Lookup API - Each editor provides an EditorKit which controls the policy of specific MIME content type.
Module System API - The Modules API lies at the core of NetBeans and describes how plug-in modules are added and managed.
MultiView Windows - Multi views are general mechanism for displaying several perspectives, or views of data, which will be used consistently across whole IDE window system.
Navigator API - Navigator module is a base API module which provides: A place for modules to show structure/outline of their documents Ability for modules to show their view only when special document(node) is active in the system UI for switching between multiple views available for currently active document(node) Coalescing of fast coming selected node changes to show content for .
NB JUnit - Module contains NetBeans extension to JUnit.
Nodes API - Nodes API serves as the main aparatus for visualisation of objects in NetBeans.
Old Enumeration API - OldEnumerationsAPI .
Options Dialog and SPI - This module contains implementation of Options Panel and simple SPI.
Parsing API - See Parsing API homepage for project requirements, motivation.
Print - Provides print functionality in NetBeans.
Progress API - The progress API is good for tracking progress of long lasting tasks in the IDE.
Project API - Provides a generic infrastructure for modelling projects.
Project UI - General user interface implementation for the project system.
Project UI API - The module supplies the APIs for the basic, generic UI infrastructure for projects: list of opened projects, main project, basic project-sensitive actions, template wizards, etc.
Quick Search API - QuickSearch API and its implementations provides way for end user to learn system earlier and easier and also to find various things in the system more quickly, conveniently and in standard way.
Refactoring API - Refactoring module allows developer to do high level code transformations aka refactorings.
Search API - It allows other modules to define how the nodes they define should be searched, without depending on any concrete module containing the search feature.
Settings API - Settings are persistent objects with a set of properties, that should be available via lookup.
Settings Options API - org.openide.options .
Startup - XXX no answer for arch-what .
Tab Control - The tab control is a swing control used by NetBeans window system, similar in function to a JTabbedPane, which allows the user to see and select tabs that contain different components.
Task List API - This module provides SPI for third parties that want to display some sort information for the user in the Task List / Problems window.
Text API - The EditorAPI is used for accessing editor-related functionality from within the IDE for use by other modules and the core IDE itself.
TreeTableView Model - The debuggercore/ViewModel module (View Model) allows to share one TreeTableView among different modules.
UI Gestures Collector Infrastructure - XXX no answer for arch-what .
UI Handler Library - XXX no answer for arch-what .
UI Utilities API - The org.openide.awt provides API/SPI for UI related aspects of application.
Utilities API - Described in the overall answer.
Visual Library API - The Visual Library 2.0 is the next generation of the original Graph Library 1.0.
Web APIs - There are multiple IDE modules that need access to definition of web module.
Window System API - Window System API is used to display and control application GUI: Main window, frames, components.
XML Tools API - It helps with editing XML files and supports leveraging XML in developed application.
org-netbeans-modules-java-api-common - no API description provided (see how to do it)

Ant

javadoc | download | architecture | usecases

The Ant integration module recognizes Ant build scripts, facilitates editing them as text or structurally, lets the user run targets or create shortcuts to them, etc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
AntLogger	Stable	org-apache-tools-ant-module/org/apache/tools/ant/module/spi/AntLogger.html Permits customization of the way Ant output is displayed.
AutomaticExtraClasspathProvider	Stable	org-apache-tools-ant-module/org/apache/tools/ant/module/spi/AutomaticExtraClasspathProvider.html Permits additions to the default Ant classpath.
IntrospectedInfo	Stable	org-apache-tools-ant-module/org/apache/tools/ant/module/api/IntrospectedInfo.html Examining cached and introspected data about which tasks and types are known to be defined in the user's Ant scripts, and what their design-time structure is. Used by XML code completion, for example.
AntTargetExecutor	Stable	org-apache-tools-ant-module/org/apache/tools/ant/module/api/AntTargetExecutor.html Running named targets in specified Ant scripts. Can be used by modules which provide a different UI for initiating Ant execution. `ActionUtils` provides a more convenient wrapper around this functionality.
Set of java.io.File APIs	Individual	table with definitions
Set of layer APIs	Individual	table with definitions

Common Annotations

javadoc | download | architecture | usecases

Provides common annotations serving as a documentation element and for static code analysis.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
CommonAnnotationsAPI	Stable	org-netbeans-api-annotations-common/org/netbeans/api/annotations/common/package-summary.html

Debugger Core API

javadoc | download | architecture | usecases

The debuggercore/api module (Debugger Core API) allows to install different debugger implementation to one IDE. It allows to share some common UI components.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
DebuggerCoreAPI	Official	./org-netbeans-api-debugger

JPDA Debugger API

javadoc | download | architecture | usecases

The debuggerjpda/api (Debugger JPDA API) defines API for NetBeans Java Debugger.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
JPDADebuggerAPI	Official	./org-netbeans-api-debugger-jpda
Set of property APIs	Individual	table with definitions

Java Support APIs

javadoc | download | architecture | usecases

Provides java specific queries (javadc, source level) used by other modules like java language infrastructure. More information in the Javadoc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
JavaSupportAPIs	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.

Classpath APIs

javadoc | download | architecture | usecases

Models basic aspects of the metadata surrounding list of source roots, such as the classpath. More information in the Javadoc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ClassPathAPIs	Official	The ClassPath APIs provides java classpath like ordered collection of (source) roots with ability to listen on changes and helper methods like finding the file under the roots, returning a path from root to given file. It also provides a registry where projects register their classpaths to make them visible to languages infrastructure.

Progress API

javadoc | download | architecture | usecases

The progress API is good for tracking progress of long lasting tasks in the IDE.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
Progress	Official	./org-netbeans-api-progress/index.html

Visual Library API

javadoc | download | architecture | usecases

The Visual Library 2.0 is the next generation of the original Graph Library 1.0. It is designed for a general visualization with a support for graph-oriented modeling. Its focus is to become a part of the NetBeans platform and unify the visualization (UI and API) used in NetBeans-Platform-based applications. See http://graph.netbeans.org/ web-site for details. See documentation for complete set of use-cases and code-snippets.

Usage:

No. Just set a normal project dependency on org.netbeans.api.visual (spec no.: 2.0) module.

Interface Name

Stability Classification

Specified in What Document?

VisualLibraryAPI

Official

The API provides a set of reusable pieces - widgets. By composing them you are creating a visualization. Each widget has various properties including layout, border, assigned actions, ... The library contains a set of pre-defined widgets that can be extended. All pluggable pieces are declared as interfaces or abstract classes - WidgetAction, Anchor, AnchorShape, PointShape, Animator, Border, GraphLayout, LookFeel, Layout, SceneLayout, Router, CollisionsCollector. Also they all have their built-in implementation.

Web APIs

javadoc | download | architecture | usecases

There are multiple IDE modules that need access to definition of web module. On one side there are modules that provide wizards, edititing, debugging etc. for JSPs, web.xml, servlets, and similar. On the other side there are also multiple project types that can contain web modules in them. This API/SPI exists for communication between these two types of modules.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
WebModuleAPI	Under Development	The API part provides access to web module properties and defines constants for use web module projects (such as action commands or source types). The SPI part can be implemented by modules that provide web module "project" support. It can be implemented with project APIs but other implementations are also possible. There is also an SPI which allows implementors to provides support for web frameworks such as Struts and JSF.

XML Tools API

javadoc | download | architecture

It helps with editing XML files and supports leveraging XML in developed application.

Interface Name	Stability Classification	Specified in What Document?
XMLAPIs	Official	index.html

Bootstrap

javadoc | download | architecture | usecases

The NetBeans launcher starts the application. Different launchers are provided for different supported platforms - Unix/Linux, Windows, and others. There are also a handful of classes in the org.netbeans and org.netbeans.core packages which directly support early startup features, such as command-line options.

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
ExceptionAnnotatableUsingLogRecords	Friend	To support classification of exceptions and also annotation of exceptions with logging levels and additional localized messages, logged exceptions and their initCause's are searched for implementation of `Callable<LogRecord[]>`. If an exception implements this interface, the `call()` method is called and returned `LogRecords` then scanned for messages, levels, etc.
Set of java.io.File APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of logger APIs	Individual	table with definitions
Set of cli APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions

Core - IDE

javadoc | download | architecture | usecases

core.ide

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
core.ide	Stable	Right now this module provides handy ServicesTabNodeRegistration accompanied with few UI elements.

MultiView Windows

javadoc | download | architecture | usecases

Multi views are general mechanism for displaying several perspectives, or views of data, which will be used consistently across whole IDE window system. Using multi views will enable modules to visually represent data document or object in unified manner at one specific place in the system, yet still allowing for different perspectives of data viewing.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
MultiView	Under Development	org-netbeans-core-multiview/overview-summary.html

Startup

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
Set of property APIs	Individual	table with definitions

UI Handler Library

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
UIGestureCollectorLibrary	Under Development	Library with utilities for UI Gesture Collector module as well as for the server processing the results.

Auto Update Services

javadoc | download | architecture | usecases

org.netbeans.api.autoupdate org.netbeans.spi.autoupdate

Usage:

Interface Name	Stability Classification	Specified in What Document?
org.netbeans.api.autoupdate	Official	org-netbeans-modules-autoupdate-services/overview-summary.html
org.netbeans.spi.autoupdate	Official	org-netbeans-modules-autoupdate-services/overview-summary.html
Set of property APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions
Set of preferences APIs	Individual	table with definitions

Classfile Reader

javadoc | download | architecture | usecases

The ClassFile API is designed as a fast, low memory-cost way to access classfile information. It is useful for tools and modules that directly read classfiles, such as the clazz and javacore modules.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
classfile	Stable

Database Explorer

javadoc | download | architecture | usecases

This project provides access to objects defined in the Database Explorer. Documentation is available in the Javadoc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
DatabaseExplorerAPI	Official	org-netbeans-modules-db/index.html
SQLSupportAPI	Official	org-netbeans-modules-db/org/netbeans/api/db/sql/support/package-summary.html
Set of layer APIs	Individual	table with definitions

Diff

javadoc | download | architecture | usecases

The diff module provides the ability to visualize differencies between source files. It also has a graphical conflicts resolver tool and built-in patch algorithm. List of the main features: Simple APIs, that provide access to registered diff and merge engines and visualizers. Built in and external diff engines defined. Graphical diff vizualizer and conflicts resolver. Extensible with additional diff and merge engines and vizualizers. Patch algorithm implemented for UNIX-style, unidiff and contextual diff formats.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
DiffAPI	Official
DiffImplementationAPI	Friend

Editor Module

javadoc | download | architecture | usecases

The editor module provides a full-featured source text editor that is integrated with the Form Editor, Explorer, compiler, and debugger. List of the main features: Syntax highlighting of java, HTML, XML and other languages. Code Completion enables to type a few characters and then display a list of suggestions appropriate in the given context that can be then used to automatically complete the expression. Word Matching enables enables to type the beginning characters of a word used elsewhere in the code and then have the editor generate the rest of the word. Abbreviations allow to expand typed text from a few predefined characters into a full word or phrase. Goto Class enables to open a Java file in the Source Editor by typing only the class name. The IDE helps to identify the correct package name for the class. The Fast Import feature enables to quickly add import statements for Java classes in the source file. Goto Declaration feature allows to quickly jump to a declaration of a variable under the cursor. Goto Source allows to open source file containing definition of a type that the variable under the cursor is of. Code folding allows to collapse sections of the code that are unimportant to the user at the given time. For example in java source the collapsable sections include imports section, inner classes, methods and javadocs.

Usage:

Nothing.

Interface Name

Stability Classification

Specified in What Document?

EditorModuleAPI

Under Development

Editor defines APIs and SPIs both by

Providing java classes in public packages for further reuse.
Most of the classes were created spontaneously (several years ago) without fulfilling of the rules imposed on APIs and SPIs at the present time.
There is an ongoing work to revisit the existing classes and create stable APIs and SPIs (and possibly extract functionality into a submodule where appropriate). However this is a long-term task spanning several promotions.
Being sensitive to content of certain directories in xml layer.

Set of property APIs

Individual

table with definitions

Editor Braces Matching

javadoc | download | architecture | usecases

The Braces Matching SPI allows modules providing editor support for documents to create their own BracesMatchers that are tailored for the type of documents they support. The module itself provides an infrastructure for highlighting matching areas identified by a matcher and navigating between them.

Usage:

Just normal module dependency.

Interface Name	Stability Classification	Specified in What Document?
BracesMatchingSPI	Under Development	./org-netbeans-modules-editor-bracesmatching/overview-summary.html
Set of property APIs	Individual	table with definitions

Editor Code Templates

javadoc | download | architecture | usecases

Code Templates allow to paste various code snippets by using parametrized text. The parameters of the same name will share the same default value and if that value gets changed by user's typing the new value gets replicated into all the parameter's occurrences. Code Templates replace the original abbreviations functionality. Code template's example for (Iterator ${iterator} = ${collection instanceof="java.util.Collection"}.iterator(); ${iterator}.hasNext();) { ${cursor}${iterator}.next();" } Each parameter can have additional hints of what values can be assigned to it. The hint has a form ${param hint=value} or just ${param hint} which translates to ${param hint="true"} If necessary the value of the hint can be enclosed in quotes to allow to write whitespace or { or } into the value. The quote can be written by using \". Reserved parameter names ${cursor} defines position where the caret will be located after the editing of the code template default values will finish. Reserved hint names ${param editable=false} can be used to make the parameter to be skipped from user's editing. This may be useful e.g. with using java-specific type hint (described below). Java: ${ind index} defines that the default value of the parameter should be an unused variable in the given context named i. If i is already used then j is attempted or then k etc. until z. Then i0, i1 etc. are attempted. ${param type="java.util.Collection"} defines java type that the parameter must be instance of. Besides class names there can be array e.g. String[] or generics java.util.List<String> ${param array} defines parameter of array type (including arrays of primitive data types). ${param type="java.util.Iterator"} defines that the parameter has the given java type. The template processing infrastructure will use short name Iterator and import java.util.Iterator.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
CodeTemplatesAPI	Stable

Editor Code Completion

javadoc | download | architecture | usecases

Code Completion provides users with a list of suggested completions for partially typed texts in the editor and various dialog input fields. The Code Completion module was created to replace the original legacy editor code completion which lacked several key requirements: Support for multiple independent code completion content providers. Implied requirement for ordering and prioritization of the completion items. Direct support for asynchronous completion result computation. Missing separation to the API and SPI and implementation parts.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
CodeCompletionAPI	Official	org-netbeans-modules-editor-completion/index.html
Set of logger APIs	Individual	table with definitions

Editor Error Stripe

javadoc | download | architecture | usecases

The Error Stripe shows an overview of important information of an edited source code. It shows this information for the whole source code (regardless of its size).

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
TextAPI	Stable	./org-openide-text/overview-summary.html OpenIDE Text API
ErrorStripeSPI	Stable	org-netbeans-modules-editor-errorstripe-api/index.html public SPI provided by the Error Stripe.
ErrorStripePrivateSPI	Private	Private mark provider SPI.
Set of property APIs	Individual	table with definitions

Editor Code Folding

javadoc | download | architecture | usecases

The Code Folding is part of the editor module functionality and it's responsible for hiding of the portions of the code that are less important for the user at the given time.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
CodeFoldingAPI	Official

Editor Guarded Sections

javadoc | download | architecture | usecases

Guarded Sections protects user from modifying document content. The main goal is to simplify work with such a content to module writers and preserve created sections.

Usage:

A module using the Guarded Sections API should also require a proper implementation. Eg in case of java content add to your module manifest file:

        OpenIDE-Module-Requires: org.netbeans.api.editor.guards.Java

A module implementing the Guarded Sections SPI should provide a token in the manifest file. Eg in case of java content add:

        OpenIDE-Module-Provides: org.netbeans.api.editor.guards.Java

Interface Name	Stability Classification	Specified in What Document?
GuardedSectionsAPI	Official	The Guarded Sections module is supposed to operate over the Swing's `StyledDocument`. It allows clients to manipulate named guarded sections that prevents user to modify the content. So if you like to create, modify or delete guarded sections the `GuardedSectionManager` is the best place where to start.
GuardedSectionsSPI	Official	The module also allows to implement custom guarded section persistance in various content types like java, xml, ... The easiest way is to subclass `AbstractGuardedSectionsProvider`. In order to bind guarded sections to your editor see `GuardedSectionsFactory`.
Set of property APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions

Editor Indentation

javadoc | download | architecture | usecases

Editor indentation performs reindentation and code beautification of Swing document.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
EditorIndentationAPI	Under Development

Editor Library

javadoc | download | architecture | usecases

The editor library module provides subset of editor functionality independent on the NetBeans IDE (except few specific standalone classes). List of the main features: Syntax highlighting of java, HTML, XML and other languages. Code Completion enables to type a few characters and then display a list of suggestions appropriate in the given context that can be then used to automatically complete the expression. Word Matching enables enables to type the beginning characters of a word used elsewhere in the code and then have the editor generate the rest of the word. Abbreviations allow to expand typed text from a few predefined characters into a full word or phrase. Goto Class enables to open a Java file in the Source Editor by typing only the class name. The IDE helps to identify the correct package name for the class. The Fast Import feature enables to quickly add import statements for Java classes in the source file. Goto Declaration feature allows to quickly jump to a declaration of a variable under the cursor. Goto Source allows to open source file containing definition of a type that the variable under the cursor is of. Code folding allows to collapse sections of the code that are unimportant to the user at the given time. For example in java source the collapsable sections include imports section, inner classes, methods and javadocs.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
EditorHyperlinkSPI	Under Development	Hyperlink SPI in `org.netbeans.lib.editor.hyperlink.spi` allows the editors for a particular mime-type to respond to the situation when a user hovers over the text with a Ctrl key pressed.
EditorLibraryModuleAPI	Under Development	Editor defines APIs and SPIs both by Providing java classes in public packages for further reuse. Most of the classes were created spontaneously (several years ago) without fulfilling of the rules imposed on APIs and SPIs at the present time. There is an ongoing work to revisit the existing classes and create stable APIs and SPIs (and possibly extract functionality into a submodule where appropriate). However this is a long-term task spanning several promotions. Being sensitive to content of certain directories in xml layer.
Set of property APIs	Individual	table with definitions

Editor Library 2

javadoc | download | architecture | usecases

The Editor Library 2 module is a set of official APIs and SPIs, designed to replaces the original Editor Library with legacy APIs that are not properly structured and do not conform to the rules implied on the current NB APIs. The APIs currently offered in Editor Library 2 module include: editor-highlighting

Usage:

Just normal module dependency.

Interface Name	Stability Classification	Specified in What Document?
editor-highlighting	Official	./org-netbeans-modules-editor-lib2/org/netbeans/spi/editor/highlighting/package-summary.html Highlighting SPI
Set of property APIs	Individual	table with definitions

MIME Lookup API

javadoc | download | architecture | usecases

Each editor provides an EditorKit which controls the policy of specific MIME content type. The policy of content type should be easily registered and found via some lookup mechanism, that will provide convenient way of using it either for kit provider or base editor infrastructure. In addition to this, the policy can be inherited, (e.g. in case of embeded kits like JSP) and the content types need to be merged in this case. MIME Lookup API should provide all mentioned requierements via easy lookup query, so content type policy user need not to solve this searching and merging on its own side.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
MimeLookupAPI	Official
MimeLookupSPI	Official

Editor Settings

javadoc | download | architecture | usecases

The legacy settings system in the editor module is complicated, error prone and hard to use. It'd been created spontaneously over the years to support immediate needs at that time without paying enough attention to extensibility and interoperability. Historically any module providing editor settings needed to depend on the whole editor module. The main purpose of this project is to define API for editor settings, that is lightweight and easily extensible. The API relies on MimeLookup to provide a way of registering and looking up settings. The aim is NOT to provide an implementation of a storage for editor settings, but to define an interface between this storage and clients like <mime-type> editors, externaleditor, etc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
EditorSettingsAPI	Official	API

Editor Settings Storage

javadoc | download | architecture | usecases

The module is an implementation of the org.netbeans.modules.editor.settings providing a settings storage on the default filesystem.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
EditorSettingsStorageAPI	Friend
SpecialProfilesAndMimeTypesAPI	Friend
Set of dtd APIs	Individual	table with definitions

Editor Utilities

javadoc | download | architecture | usecases

Editor Utilities module contains useful utility classes and methods used by other editor related modules.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
EditorUtilitiesAPI	Friend

External Execution Support

javadoc | download | architecture | usecases

Provides common APIs to execute external process in the IDE to handle its streams and present the output to the user. Input/line processing can be used as separate part.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ExternalExecutionAPI	Stable	org-netbeans-modules-extexecution/org/netbeans/api/extexecution/package-summary.html
ExternalExecutionInputAPI	Stable	org-netbeans-modules-extexecution/org/netbeans/api/extexecution/input/package-summary.html
ExternalExecutionInputPrintingAPI	Stable	org-netbeans-modules-extexecution/org/netbeans/api/extexecution/print/package-summary.html
ExternalExecutionDestroySPI	Stable	org-netbeans-modules-extexecution/org/netbeans/spi/extexecution/destroy/package-summary.html

J2EE DD API

javadoc | download | architecture | usecases

The project is based on the requirement to access all J2ee deployment descriptor files for other Netbeans modules in a simple and J2EE spec.-independant way. This module replaces the Web DD API (web/ddapi) module form the Web area.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
J2EEDDAPI	Friend	index.html The J2EE DD API is based on a bunch of interfaces based on the deployment descriptor xml structure. The names of interfaces correspond to the names of deployment descriptor elements in the J2EE DD files like ejb-jar.xml, web.xml or applicaiton.xml. The DD API interfaces are organized in a hierarchic tree structure and are accassible through the root (Application), (WebApp) or (EjbJar) interfaces. The implementation of DD API interfaces is hidden for clients. It is based on schema2beans infrastructure and is the DD version - specific. (there is always requirement to support at least two successive versions of DD specification). The implementation is located in non-public packages of j2ee/ddapi module. It is expected that interfaces will not be implemented by the client. The root of the deployment descriptor is accessible through the DDProvider class.

Java EE Metadata

javadoc | download | architecture | usecases

The project provides a generic framework for accessing Java EE metadata models.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
GenericJavaEEMetadataModelAPI	Under Development	org-netbeans-modules-j2ee-metadata/index.html

Java EE Server Registry

javadoc | download | architecture | usecases

J2EE Server Module provides support for development of J2EE modules and framework for J2EE server management and for J2EE deployment in IDE.

Usage:

Tomcat plugin (org.netbeans.modules.tomcat5), Web Core (org.netbeans.modules.web.core), Web Projects (org.netbeans.modules.web.project).

Interface Name

Stability Classification

Specified in What Document?

J2EEServerAPI

Friend

J2EE Server module serves as an integration point between two kinds of netbeans modules:

server plugins (or simply plugins) that integrate various J2EE servers in IDE, and
devmodules - netbeans modules that provide support for development of J2EE modules (web module, EJB module, J2EE Application, etc.) and need to deploy and debug them on J2EE servers.

Set of layer APIs

Individual

table with definitions

Java SE Projects

javadoc | download | architecture | usecases

Provides a project type for plain Java projects. J2SE projects can be created from scratch, or you can import existing Java source trees. Creates an Ant script letting you build the project (and subprojects), run it, debug it, run JUnit-format tests, and build Javadoc. GUI customizer permits easy customization of the most commonly needed project parameters. Provides code completion and other services for editing Java sources. Classpaths can include other projects, raw JARs, or configured libraries. Specific J2SE platforms may be configured.

Usage:

N/A

Interface Name	Stability Classification	Specified in What Document?
J2SEPropertyEvaluator	Friend	Module provides public package `org.netbeans.modules.java.j2seproject.api` with interface for resolving values of project properties defined in project.properties and private.properties files.
Set of java.io.File APIs	Individual	table with definitions
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions

Java Platform

javadoc | download | architecture | usecases

Many Java-based project types need to be able to configure the version and location of Java to be used when building and running the project. This API/SPI permits these platforms to be registered and queried, and any customizations made in an appropriate GUI and persisted to disk.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
JavaPlatformAPI	Official	The Java Platform API permits access to installed Java platforms (for example, the J2SE JDK, or various mobile-device emulators for J2ME). Particular platform types are registered by modules and can store customized information about the platform to disk.

Java Project Support

javadoc | download | architecture | usecases

Provides support infrastructure for projects working with the Java language.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
JavaProjectAPI	Official	The Java Project API is actually entirely SPI and supplies useful implementations of Java-related functionality specific to the project system.
ProjectClassPathExtender	Under Development	Implemented by `java/j2seproject` and asked for by `form`. Permits the Form Editor to add JavaBeans archives to the classpath of a J2SE project automatically.
ProjectClassPathSupport	Under Development	Support class containg helper method for creating `ClassPathImplementation` based on Ant properties.
Set of property APIs	Individual	table with definitions

Java Source

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
JavaSourceAPI	Official	org-netbeans-modules-java-source/index.html
Set of property APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions

Java Source UI

javadoc | download | architecture | usecases

java.sourceui

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
java.sourceui	Official	APIs for controling visual aspects of processing of Java files.

JavaHelp Integration

javadoc | download | architecture

The JavaHelp integration API wraps the standard JavaHelp extension library. It also provides a small additional API for NetBeans modules to supply help sets to the system, add GUI menu items, and request that particular help topics be displayed. JavaHelpIntegrationAPI

Interface Name	Stability Classification	Specified in What Document?
JavaHelpIntegrationAPI	Official	org-netbeans-modules-javahelp/index.html
Set of property APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions

JUnit Tests

javadoc | download | architecture | usecases

The module makes creating, running and navigation between tests easier. (Actual test running is typically performed directly by a project type provider using Ant.)

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
org.netbeans.modules.junit.plugin	Under Development	This SPI describes services provided by the custom JUnit support plugin which are not desribed by the existing public SPI (`UnitTestForSourceQuery`). This SPI represents an additional source of information for the JUnit module and allows a custom test-skeleton generator to be plugged.
Set of lookup APIs	Individual	table with definitions

Lexer

javadoc | download | architecture | usecases

Lexer module provides token lists for various text inputs. Token lists can either be flat or they can form tree token hierarchies if any language embedding is present. Tokens

Usage:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.lexer/2 > @SPECIFICATION-VERSION@

Interface Name	Stability Classification	Specified in What Document?
LexerAPI	Official
Set of logger APIs	Individual	table with definitions

Master Filesystem

javadoc | download | architecture | usecases

MasterFileSystems is just implementation of FileSystem provided in standalone module including implementation of URLMapper that resolves file protocol and is responsible for conversion from URL into FileObject and vice versa. Implementation just delegates to the other FileSystem implementations (LocalFileSystem, VCSFileSystem, ...) and playes the role of arbiter that controls instantiation and life cycle of provided FileObjects. MasterFileSystemAPI

Usage:

Nothing currently. Most "clients" are really callers of FileUtil.toFileObject and so on, and thus implicitly depend on the existence of this module. In the future a provide-require token might make sense.

Interface Name	Stability Classification	Specified in What Document?
MasterFileSystemAPI	Friend	org-netbeans-modules-masterfs/org/netbeans/modules/masterfs/providers/package-summary.html

NB JUnit

javadoc | download | architecture | usecases

Module contains NetBeans extension to JUnit. It is a library used in XTest and library wrapper module.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
Set of property APIs	Individual	table with definitions

Options Dialog and SPI

javadoc | download | architecture | usecases

This module contains implementation of Options Panel and simple SPI.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
OptionsDialogSPI	Official	./org-netbeans-modules-options-api/org/netbeans/spi/options/OptionsCategory.html
Set of layer APIs	Individual	table with definitions

Parsing API

javadoc | download | architecture | usecases

See Parsing API homepage for project requirements, motivation.

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
ParsingAPI	Under Development	org-netbeans-modules-parsing-api/index.html

Print

javadoc | download | architecture | usecases

Provides print functionality in NetBeans.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
PrintAPI	Stable

Ant-Based Project Support

javadoc | download | architecture | usecases

Provides the basic infrastructure by which Ant-based projects can be created, read and write configuration parameters and properties from/to disk, satisfy common queries and interfaces, etc. See Javadoc and build system design document.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
AntProjectAPI	Official	Mostly an SPI for creating project types centered around the Ant build tool. Permits Ant-based project types to be registered and supplies various support implementations to help satisfy the contract of `Project` and various optional interfaces.
Set of property APIs	Individual	table with definitions
Set of preferences APIs	Individual	table with definitions

External Libraries

javadoc | download | architecture | usecases

Permits libraries to be defined, customized, and stored by the user for reuse in multiple projects. For example, a Java JAR library has a classpath (usually one JAR), and an optional source path and Javadoc path that may be used for development-time features.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ProjectLibrariesAPI	Official	The Project Libraries API permits definitions of libraries to be registered and persisted. Library type providers may be registered and can construct memory objects corresponding to persistent library definitions.
Set of dtd APIs	Individual	table with definitions

Project API

javadoc | download | architecture | usecases

Provides a generic infrastructure for modelling projects. Documentation available in the Javadoc. The build system design overview describes the basic purpose of modelling projects.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ProjectAPI	Official	The Project API defines abstract projects, i.e. groupings of files built and manipulated as units. It is used for Ant-based projects but could support other scenarios such as makefiles. Modules can plug in project types which can recognize certain folders as being projects, and define their behaviors. Besides the visible Javadoc, this module permits a project to add implementations of `org.netbeans.spi.queries.FileBuiltQueryImplementation`, `org.netbeans.spi.queries.SharabilityQueryImplementation` and `org.netbeans.spi.queries.FileEncodingQueryImplementation` into the project lookup (rather than global lookup). The implementations will be consulted only in the case the relevant file belongs to that project (according to `org.netbeans.api.project.FileOwnerQuery`). This helps avoid the need to consult irrelevant query implementations.

Project UI

javadoc | download | architecture | usecases

General user interface implementation for the project system. UI Specification

Usage:

N/A

Interface Name	Stability Classification	Specified in What Document?
RecentProjects	Friend	http://www.netbeans.org/issues/show_bug.cgi?id=57073 API can be used to get list of information about recently opened projects in IDE. API provides project display name, icon and URL of project folder location. Listeners can be registered to learn about change of the list.
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of logger APIs	Individual	table with definitions
Set of preferences APIs	Individual	table with definitions

Project UI API

javadoc | download | architecture | usecases

The module supplies the APIs for the basic, generic UI infrastructure for projects: list of opened projects, main project, basic project-sensitive actions, template wizards, etc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ProjectUIAPI	Official	The Project UI API provides some miscellaneous APIs and SPIs relating to the appearance and UI behavior of generic projects. Most importantly, it permits the customizer and logical view of a project to be defined.
ProjectUIAPI-provider	Friend	Callbacks intended to let the Project UI module plug in implementations of APIs defined here. Uses implementation dependencies.
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions

General Queries API

javadoc | download | architecture | usecases

General kinds of queries between modules. Queries are one way of solving the intermodule communication problem when it is necessary for some modules to obtain basic information about the system (e.g. whether a particular file is intended for version control) without needing direct dependencies on the module providing the answer (e.g. the project type which controls the file). Details are covered in the Javadoc.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
GeneralQueriesAPI	Official	The General Queries API provides generic queries, or sources of concrete information, useful throughout the build system and perhaps elsewhere. Each query is split into an API component intended for clients to find the answer to a particular question without knowledge of the underlying structure or origin of the answer; and an SPI interface (using lookup) permitting answers to be provided from any source. These queries currently pertain to VCS and compilation status and user visibility of files.
Set of preferences APIs	Individual	table with definitions

Refactoring API

javadoc | download | architecture | usecases

Refactoring module allows developer to do high level code transformations aka refactorings.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
RefactoringAPI	Under Development
RefactoringSPI	Under Development
Set of lookup APIs	Individual	table with definitions

Java Refactoring

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
JavaRefactoringAPI	Under Development

Command Line Parsing API

javadoc | download | architecture | usecases

GetOpts like infrastructure to parse command line arguments with the cooperative participation of various modules.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
SendOptsAPI	Official	org-netbeans-modules-sendopts/org/netbeans/api/sendopts/package-summary.html
SendOptsSPI	Official	org-netbeans-modules-sendopts/org/netbeans/spi/sendopts/package-summary.html
Set of lookup APIs	Individual	table with definitions

Common Server

javadoc | download | architecture | usecases

Allows UI presentation of server instance without dependency on a server specific API (like j2eeserver).

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
CommonServerSPI	Under Development	org-netbeans-modules-server/org/netbeans/spi/server/package-summary.html
CommonServerAPI	Under Development	org-netbeans-modules-server/org/netbeans/api/server/package-summary.html
CommonServerPropertiesAPI	Under Development	org-netbeans-modules-server/org/netbeans/api/server/properties/package-summary.html
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions

Settings API

javadoc | download | architecture

Settings are persistent objects with a set of properties, that should be available via lookup. Properties are expected to be changed. Implementation of setting doesn't care about persistence issues, which is responsibility of settings infrastructure. XML persistence support is provided in a standalone autoload module core-settings.jar. Also service types must be mentioned here. Service type can be desribed as typed a named settings. SettingsAPI ServicesAPI XmlSettingsPersistence

Interface Name	Stability Classification	Specified in What Document?
SettingsAPI	Official	./org-openide-util/org/openide/util/doc-files/api.html#settings
ServicesAPI	Official	./org-openide-util/org/openide/util/doc-files/api.html#service-lookup
XmlSettingsPersistence	Official	./org-netbeans-modules-settings/org/netbeans/spi/settings/doc-files/api.html
Set of layer APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions

UI Gestures Collector Infrastructure

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

Modules may use functionality of this module either by depending on its presence and registering callback interfaces provided by its API. Or the modules do not need to depend on this module at all, and just generate log records to the org.netbeans.ui.someloggername log. These records are then going to be consumed by this module, if enabled.

Interface Name	Stability Classification	Specified in What Document?
CallbackInterfaces	Under Development	org-netbeans-modules-uihandler/org/netbeans/modules/uihandler/api/Activated.html interfaces from the API of this module
Set of java.io.File APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of logger APIs	Individual	table with definitions
Set of preferences APIs	Individual	table with definitions

Debugger Core - UI

javadoc | download | architecture | usecases

The debuggercore module (Debugger Core UI) contains shared UI components for all debugger implementations, and defines some SPI for sharing of them.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
DebuggerCoreUI-SPI	Official	./org-netbeans-spi-debugger-ui

Editor Hints

javadoc | download | architecture | usecases

XXX no answer.

Usage:

Normal module dependencies are used for this module.

Interface Name	Stability Classification	Specified in What Document?
EditorHintsSPI	Under Development	org-netbeans-spi-editor-hints/org/netbeans/spi/editor/hints/package-summary.html allows to show errors in the editor, with possible fixes.

Navigator API

javadoc | download | architecture | usecases

Navigator module is a base API module which provides: A place for modules to show structure/outline of their documents Ability for modules to show their view only when special document(node) is active in the system UI for switching between multiple views available for currently active document(node) Coalescing of fast coming selected node changes to show content for

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
org.netbeans.spi.navigator.NavigatorPanel	Stable
org.netbeans.spi.navigator.NavigatorHandler	Under Development
Set of lookup APIs	Individual	table with definitions

Common Palette

javadoc | download | architecture | usecases

The project implements a new component palette that will be reused by other projects. The new palette should provide a common look and feel for Form editor, Mobility, J2EE and possible other modules as well. UI draft specification is available at http://ui.netbeans.org/docs/ui/palette/index.html

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
Palette	Stable	org-netbeans-spi-palette/overview-summary.html
Set of java.io.File APIs	Individual	table with definitions
Set of layer APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions

Quick Search API

javadoc | download | architecture | usecases

QuickSearch API and its implementations provides way for end user to learn system earlier and easier and also to find various things in the system more quickly, conveniently and in standard way. Main project page is on nb wiki, http://wiki.netbeans.org/QuickSearch

Usage:

Nothing, regular depencency is enough.

Interface Name	Stability Classification	Specified in What Document?
SearchProvider	Official	org-netbeans-spi-quicksearch/org/netbeans/spi/quicksearch/SearchProvider.html
SearchRequest	Official	org-netbeans-spi-quicksearch/org/netbeans/spi/quicksearch/SearchRequest.html
SearchResponse	Official	org-netbeans-spi-quicksearch/org/netbeans/spi/quicksearch/SearchResponse.html
Set of property APIs	Individual	table with definitions

Task List API

javadoc | download | architecture | usecases

This module provides SPI for third parties that want to display some sort information for the user in the Task List / Problems window. A typical example are Java errors, warnings, TODOs etc. Part of the integration are several implementation modules that provider task list user interface, TODO task scanning, Java integration.

Usage:

no special dependency declarations

Interface Name	Stability Classification	Specified in What Document?
TaskListSPI	Official	org-netbeans-spi-tasklist/org/netbeans/spi/tasklist/package-summary.html
Set of layer APIs	Individual	table with definitions

TreeTableView Model

javadoc | download | architecture | usecases

The debuggercore/ViewModel module (View Model) allows to share one TreeTableView among different modules.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ViewModel	Official	./org-netbeans-spi-viewmodel/overview-summary.html

ETable and Outline

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

Nothing

Interface Name	Stability Classification	Specified in What Document?
ETable	Under Development	org-netbeans-swing-outline/org/netbeans/swing/etable/ETable.html ETable
Outline	Under Development	org-netbeans-swing-outline/org/netbeans/swing/outline/Outline.html Outline

Look & Feel Customization Library

javadoc | download | architecture | usecases

The plaf library consists primarily of code that used to be in core. What it does: Installs a custom look and feel if a custom look and feel class is passed to it Sets the correct fonts in the Swing UIDefaults if a custom fontsize is desired for the application's UI Loads a UI theme if a URL for the theme file (no format changes since NetBeans 3.4) is passed to it Installs custom UI keys and values used by other components of NetBeans, such as colors and UI delegate class names used by other parts NetBeans. Examples of these: Tab control UI delegate class name, depending on the look and feel, for the window system Definitions of colors which the tab control, property sheet and output window will use, if present in UIDefaults, to color themselves in accordance with the UI spec for them on a given look and feel Custom border implementations NetBeans uses for scroll panes to reduce "border-buildup" A custom implementation of ToolbarUI which NetBeans uses for its toolbars, and a custom UI for toolbar buttons which sizes them correctly (GTK and Aqua only, currently) Insets definition for the editor scrollbar, used to get the height of the upper and lower button of the scrollbar for purposes of the Error Stripe. The appropriate key value is "Nb.Editor.ErrorStripe.ScrollBar.Insets". Compensate for missing elements on some (GTK) look and feels, which standard Swing code expects to be present, i.e. UIManager.getColor ("control"), to enable older code to run unmodified on newer look and feels. Its API consists of a single method, org.netbeans.swing.plaf.Startup.run (Class lookAndFeel, int fontSize, URL themeFile), which should be called early in NetBeans startup sequence by core, to initialize UIDefaults values before any main window GUI is constructed. It provides a minimal SPI in the form of the abstract class LFCustoms, which an alternate look and feel could use to provide lists of keys and values which should be installed into UIDefaults, via the mechanism documented in the documentation for LFCustoms. PlafAPI

Usage:

Components such as the window system, which use values defined here, will behave in a reasonable way if those values are not defined. However, it is preferable that they declare a runtime dependency on the plaf library.

Interface Name	Stability Classification	Specified in What Document?
PlafAPI	Friend	org-netbeans-swing-plaf/org/netbeans/swing/plaf/package-summary.html

Tab Control

javadoc | download | architecture | usecases

The tab control is a swing control used by NetBeans window system, similar in function to a JTabbedPane, which allows the user to see and select tabs that contain different components. It defines two GUI components: TabbedContainer (similar to JTabbedPane) and TabDisplayer, a generic component for displaying tabs which is not associated with any particular container. Several different types of UIs (view, editor, sliding) are provided, each of which is handled by a different UI delegate class; UI delegate subclasses designed to fit with Windows, Metal, Aqua and GTK look and feels are provided. TabbedContainerAPI PopupSwitcherAPI

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
TabbedContainerAPI	Friend	org-netbeans-swing-tabcontrol/org/netbeans/swing/tabcontrol/TabbedContainer.html
PopupSwitcherAPI	Friend	org-netbeans-swing-tabcontrol/org/netbeans/swing/popupswitcher/package-summary.html API contains classes used only by switchers accessible through main menu in "Window/Documents..." and "Go To/Recent Document". Besides this module the package is used from core/windows too. Classes contained in the package are rather general and therefore this package could be moved in the future. It is placed here only due to current modules dependencies. Consequently the package is not intended for external use. For more information on `SwitcherTable` and `SwitcherTableItem` see a javadoc.
Set of property APIs	Individual	table with definitions

Actions APIs

javadoc | download | architecture | usecases

Actions provides system of support and utility classes for 'actions' usage in NetBeans.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
ActionsAPI	Official	org-openide-actions/overview-summary.html
Set of property APIs	Individual	table with definitions
Set of preferences APIs	Individual	table with definitions

UI Utilities API

javadoc | download | architecture | usecases

The org.openide.awt provides API/SPI for UI related aspects of application.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
org.openide.awt	Official	./org-openide-awt/org/openide/awt/package-summary.html
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of logger APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions

Compatibility APIs

javadoc | download | architecture | usecases

XXX no answer for arch-what

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
CompatibilityAPIs	Deprecated	This module is deprecated, do not use any classes herein.

Dialogs API

javadoc | download | architecture | usecases

The DialogsAPI allows creating a user notification, a dialog's description and also permits it to be displayed. The wizard framework allows create a sequence of panels which leads a user through the steps to complete any task. This API is part of package org.openide.

Interface Name	Stability Classification	Specified in What Document?
DialogsAPI	Official	./org-openide-dialogs/org/openide/package-summary.html#package_description

Execution API

javadoc | download | architecture

The IDE uses a small interface to describe the execution of Java-based classes together with arguments. The ExecutionAPI controls the execution of user-level classes. The system may have several different types of executors simultaneously installed. By default we provide so called External Execution for running a user code by an external process and Internal Execution for running the user code in the same virtual machine as the IDE.

Interface Name	Stability Classification	Specified in What Document?
ExecutionAPI	Official	./org-openide-execution/org/openide/execution/doc-files/api.html
Set of property APIs	Individual	table with definitions

Explorer & Property Sheet API

javadoc | download | architecture | usecases

The ExplorerAPI is build around Explorer - solely a user-interface device: it has no particular knowledge of the structure of the IDE. Rather, it provides the physical user interface for the Node hierarchy, as described in the NodesAPI. A given Explorer instance will be some visual component (such as a Swing panel) displaying some representation of a subtree of the complete Node hierarchy; the topmost node being displayed is said to be the root of the Explorer. Be careful not to confuse the root of a particular Explorer instance, which is selected according to what the user wishes to see, with the root(s) of the entire Node hierarchy, which generally are fixed.

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
ExplorerAPI	Official	./org-openide-explorer/org/openide/explorer/doc-files/api.html
TreeTableViewSortingAPI	Friend
Set of property APIs	Individual	table with definitions

File System API

javadoc | download | architecture | usecases

The Filesystems API provides a common API to access files in a uniform manner. It is available as standalone library and also is bundled together with other parts of the openide. Specification

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
FilesystemsAPI	Official	org-openide-filesystems/org/openide/filesystems/doc-files/api.html
Set of property APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions

I/O APIs

javadoc | download | architecture | usecases

The Input/Output API is a small API module which contains InputOutput and related interfaces used in driving the Output Window. The normal implementation is org.netbeans.core.output2.

Usage:

You will very likely also want to declare

OpenIDE-Module-Requires: org.openide.windows.IOProvider

to ensure that an Output Window implementation is in fact enabled.

Interface Name

Stability Classification

Specified in What Document?

InputOutputAPI

Official

./org-openide-io/org/openide/windows/package-summary.html

Just an API/SPI for defining the output window.

Datasystems API

javadoc | download | architecture | usecases

In summary, the LoadersAPI is responsible for scanning files in a directory on disk, weeding out irrelevant files of no interest to the IDE, and grouping the rest into logical chunks, or just determining what type of data each represents. It does this scanning by asking each registered data loader whether or not the given file(s) should be handled. The first loader to recognize a file takes ownership of it, and creates a matching data object to represent it to the rest of the IDE.

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
LoadersAPI	Official	org-openide-loaders/org/openide/loaders/doc-files/api.html
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions
Set of javax.swing.UIManager APIs	Individual	table with definitions

Module System API

javadoc | download | architecture | usecases

The Modules API lies at the core of NetBeans and describes how plug-in modules are added and managed. ModulesAPI

Interface Name	Stability Classification	Specified in What Document?
ModulesAPI	Official	org-openide-modules/org/openide/modules/doc-files/api.html
CoreModulesAPI	Friend
Set of property APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions

Nodes API

javadoc | download | architecture

Nodes API serves as the main aparatus for visualisation of objects in NetBeans. Nodes augment objects with standard aspects used for visualisation (e.g. name, displayName, icons, set of proerties, subnodes hierarchy, etc.) Once a Node is defined for given object it can be visualised using diferent views e.g. trees, lists, tables etc. Descripion of nodes can be found here.

Interface Name	Stability Classification	Specified in What Document?
NodesAPI	Official	org-openide-nodes/org/openide/nodes/doc-files/api.html
Set of property APIs	Individual	table with definitions

Settings Options API

javadoc | download | architecture | usecases

org.openide.options

Usage:

N/A

Interface Name	Stability Classification	Specified in What Document?
org.openide.options	Deprecated	Option API

Text API

javadoc | download | architecture | usecases

The EditorAPI is used for accessing editor-related functionality from within the IDE for use by other modules and the core IDE itself.

Usage:

XXX no answer for deploy-dependencies

Interface Name	Stability Classification	Specified in What Document?
EditorAPI	Official	./org-openide-text/org/openide/text/doc-files/api.html
EditorKitInitialization	Friend	In order to speedup, or remove the load of initialization of kit in AWT during startup, there is a special API that allows to ask the kit to pre-initialize. If the kit implements `Callable` interface from JDK, it is called in non-AWT thread. This works since version 6.18 and can be disabled by property `oldInitialization`.
Set of property APIs	Individual	table with definitions

Utilities API

javadoc | download | architecture | usecases

Described in the overall answer.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
UtilitiesAPI	Official	org-openide-util/org/openide/util/doc-files/api.html
LookupAPI	Official	org-openide-util/org/openide/util/lookup/doc-files/lookup-api.html allows the discovery
LookupSPI	Official	org-openide-util/org/openide/util/lookup/doc-files/lookup-spi.html simplifies creation and registration of own lookup objects
ProviderRegistrationRemoval	Under Development	org-openide-util/org/openide/util/doc-files/api.html#service-lookup
AWTBridge	Private	http://www.netbeans.org/source/browse/openide/util/src/org/netbeans/modules/openide/util/AWTBridge.java a class that is looked up in Lookup.getDefault() and if registered can provide better UI elements for Actions.
SharedClassObject.setAccessible	Under Development	org-openide-util/org/openide/util/SharedClassObject.html used to instantiate subclasses.
WeakListener.setAccessible	Under Development	org-openide-util/org/openide/util/WeakListeners.html used to call the remove method using reflection
Lookups.metaInfServices	Under Development	org-openide-util/org/openide/util/lookup/Lookups.html#metaInfServices(java.lang.ClassLoader) calls constructor of registered classes using reflection
Lookup.resetDefaultLookup	Friend	There is a static private method `Lookup.resetDefaultLookup` that is called by NbJUnit's `MockServices` to properly reset default lookup and fire changes to all registred listeners.
Set of java.io.File APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of lookup APIs	Individual	table with definitions

Old Enumeration API

javadoc | download | architecture | usecases

OldEnumerationsAPI

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
OldEnumerationsAPI	Deprecated	is deprecated and replaced with the Enumerations class.

Window System API

javadoc | download | architecture | usecases

Window System API is used to display and control application GUI: Main window, frames, components.

Usage:

You might use OpenIDE-Module-Requires: org.openide.windows.WindowManager but it is not generally done.

Interface Name	Stability Classification	Specified in What Document?
WindowSystemAPI	Official	org-openide-windows/org/openide/windows/doc-files/api.html
WindowSystemImplementationAPI	Friend
DataFlavorDnDTopComponent	Private	DataFlavor.javaJVMLocalObjectMimeType + "; class=org.openide.windows.TopComponent"
DataFlavorDnDTopComponent.Cloneable	Private	DataFlavor.javaJVMLocalObjectMimeType + "; class=org.openide.windows.TopComponent$Cloneable"
DataFlavorDnDTopComponentArray	Private	DataFlavor.javaJVMLocalObjectMimeType + "; class=org.netbeans.core.windows.dnd.TopComponentDragSupport$TopComponentArray"
Set of layer APIs	Individual	table with definitions
Set of property APIs	Individual	table with definitions
Set of logger APIs	Individual	table with definitions
Set of dtd APIs	Individual	table with definitions
Set of javax.swing.UIManager APIs	Individual	table with definitions

Search API

javadoc | download | architecture | usecases

It allows other modules to define how the nodes they define should be searched, without depending on any concrete module containing the search feature.

Usage:

Nothing.

Interface Name	Stability Classification	Specified in What Document?
SearchAPI	Under Development	org-openidex-util/index.html defines interfaces `SearchInfo`, `FileObjectFilter` and a factory class `SearchInfoFactory`