Plugin for an Ant project type.
Listener for changes in Ant project metadata.
A way of mapping property names to values.
Provides a set of Ant property definitions that might be evaluated in some context.
Event object corresponding to a change made in an Ant project's metadata.
Support class for implementing Ant-based projects.
Property provider that delegates to another source.
Helps a project type (re-)generate, and manage the state and versioning of,
Utility to match Ant-style file patterns with extended glob syntax.
Utilities to create new Ant-based projects on disk.
Hook run when
Support for working with Ant properties and property files.
Helps manage inter-project references.
A raw reference descriptor representing a link to a foreign project and some build artifact used from it.
Helper class to work with source roots and typed folders of a project.
A typical project based on Ant follows a standard pattern of having a project folder containing:
A top-level editable build script.
Build products. Not sharable in a VCS.
Main logic for the build; regenerated from
General project metadata, including a declaration of the type of project, its name, some structural parameters relating to the build, a list of subprojects, etc.
Sharable build configuration for the project.
Per-user (or per-checkout) project metadata, if any.
Per-user build configuration for the project.
Cache directory containing disposable files that might speed up various operations.
Note that since Ant is not aware of the NetBeans Filesystems API, all these files must be physically present on disk, not e.g. in an archive or remote filesystem.
There may also be a file named
build.properties located in the
NetBeans user directory which can supply additional definitions needed for a
build: e.g. the locations of Java platforms and libraries. A typical
build-impl.xml loads property definitions from this global
properties file as well as the project's
The basic operations commonly performed on an Ant-based project are:
Creation from wizard, including
Loading metadata from disk.
Modifying metadata and build properties in memory, and subsequently saving to disk.
nbproject/build-impl.xml, typically based on
nbproject/project.xml with an XSLT stylesheet.
Running a build target of a well-known name in
Enumerating important build outputs ("artifacts").
Adding dependencies on "subprojects" by getting information about their artifacts and storing references to them.
Interpreting values of Ant properties found on disk, to be used in providing information to the IDE about various development files (e.g. when implementing queries).
A new category of Ant-based project can be registered in the system by
adding an implementation of
AntBasedProjectType to the default
lookup. This will get an instance of
AntProjectHelper for every project
it creates; the helper does a lot of the work required to interact with the file
structure outlined above.
To run Ant targets, use
ReferenceHelpers can also be
created by an Ant-based project and used to manage references to subprojects and
their artifacts in a high-level manner.
ProjectGenerator provides the
easiest way to create a new Ant-based project on disk. Use
GeneratedFilesHelper to make
build scripts and
ProjectXmlSavedHook to be told when
to recreate them.
To allow third-party extensions to build scripts, use
EditableProperties is a
VCS-friendly alternative to
PropertyUtils also provides various
methods for working with Ant concepts such as relative file paths, property