Overview (Ant) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.apache.tools.ant.module/3 3.27.0 2

PREV NEXT

FRAMES NO FRAMES

Ant
Stable

See:
Description

Ant

org.apache.tools.ant.module.api Examination and execution of Ant build scripts.

org.apache.tools.ant.module.api.support Utilities for examining and running Ant scripts.

org.apache.tools.ant.module.spi Ways of influencing how Ant is run inside NetBeans.

Ant
org.apache.tools.ant.module.api	Examination and execution of Ant build scripts.
org.apache.tools.ant.module.api.support	Utilities for examining and running Ant scripts.
org.apache.tools.ant.module.spi	Ways of influencing how Ant is run inside NetBeans.

The main uses of the Ant integration module are self-contained and do not interact directly with other modules: the user selects a target in an Ant script and runs it. Nonetheless, there are a few significant ways other modules can interact with this module:

AntLogger
Permits customization of the way Ant output is displayed.
register-defs
Registering custom Ant task and type definitions (when these can be run inside the NetBeans JVM only). Typically used to add special tasks which somehow script the IDE, such as connecting the JPDA debugger to a process launched by Ant.
AutomaticExtraClasspathProvider
Permits additions to the default Ant classpath.
IntrospectedInfo
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
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.

What is New (see all changes)?

Oct 14 '06 IntrospectedInfo no longer serializable

As part of a switch to the Preferences API, this class no longer needs to be serialized.
Jun 20 '06 Factory method to create AutomaticExtraClasspathProvider

AutomaticExtraClasspathProvider can now be created in a declarative way. So libraries that wish to provide such Ant extension may just do it in declarative way without depending on AutomaticExtraClasspathProvider class.
Mar 23 '05 Can now declaratively extend Ant context menu items

You may now extend the Ant main node's context menu using the layer context Loaders/text/x-ant+xml/Actions.
Mar 21 '05 Added antIncludesList (FileObject[] files, FileObject dir, boolean recursive) method

The current ActionUtils.antIncludeList (FileObject[] files, FileObject dir) generates a recursive include list for directories. The API change introduces new ActionUtils.antIncludeList (FileObject[] files, FileObject dir, boolean recursive) which generates either recursive or non recursive include depending on the value of the recursive parameter. The old method is bridged into the new one.
Jun 11 '04 Added Ant logging SPI

Added a new SPI for influencing the logging behavior of Ant. See Javadoc for details.

Use Cases

The principal use cases for the API are covered in the overall API architecture.

Exported Interfaces

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

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
AntLogger	Exported	Stable	.../tools/ant/module/spi/AntLogger.html Permits customization of the way Ant output is displayed.
AutomaticExtraClasspathProvider	Exported	Stable	.../spi/AutomaticExtraClasspathProvider.html Permits additions to the default Ant classpath.
IntrospectedInfo	Exported	Stable	.../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	Exported	Stable	.../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.

Group of java.io.File interfaces

Interface Name

In/Out

Stability

Specified in What Document?

Exported

Stable

.../org/apache/tools/ant/module/spi/package-summary.html

Registering custom Ant task and type definitions (when these can be run inside the NetBeans JVM only). Typically used to add special tasks which somehow script the IDE, such as connecting the JPDA debugger to a process launched by Ant.

Group of layer interfaces

Interface Name	In/Out	Stability	Specified in What Document?
layer-actions	Exported	Under Development	Context menu actions are read from the layer folder `Loaders/text/x-ant+xml/Actions`.

Implementation Details

Where are the sources for the module?

The sources for the module are in NetBeans CVS in ant directory.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing.

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