NetBeans API List

Current Development Version

24 Jul 2008

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.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 .
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 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 .
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 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.
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 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 .
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.
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 .
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.

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

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

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

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

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 property APIs	Individual	table with definitions
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

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

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.