Skip navigation links
org.apache.tools.ant.module/3 3.86.1 2

Ant
Stable

See: Description

Ant 
Package Description
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:

  1. AntLogger

    Permits customization of the way Ant output is displayed.

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

  3. AutomaticExtraClasspathProvider

    Permits additions to the default Ant classpath.

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

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

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 NameIn/OutStabilitySpecified in What Document?
AntLoggerExportedStable .../tools/ant/module/spi/AntLogger.html

Permits customization of the way Ant output is displayed.

AutomaticExtraClasspathProviderExportedStable .../spi/AutomaticExtraClasspathProvider.html

Permits additions to the default Ant classpath.

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

AntTargetExecutorExportedStable .../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 NameIn/OutStabilitySpecified in What Document?
register-defsExportedStable .../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 systemproperty interfaces
Interface NameIn/OutStabilitySpecified in What Document?
logger.max.line.lengthExportedPrivate

If a longer message is logged the ant logger will handle the message as plain text and will not try to hyperlink, color, fold, etc. If not set by the user a default value of 3000 will be used.

Group of layer interfaces
Interface NameIn/OutStabilitySpecified in What Document?
layer-actionsExportedUnder 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 the NetBeans Mercurial repositories.

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.

Skip navigation links
org.apache.tools.ant.module/3 3.86.1 2

Built on June 22 2019.  |   Copyright © 2017-2019 Apache Software Foundation. All Rights Reserved.