AntBuildExtender (Ant-Based Project Support) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.project.ant/1 1.16

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.project.ant
Class AntBuildExtender

java.lang.Object
  org.netbeans.api.project.ant.AntBuildExtender

public final class AntBuildExtender
extends Object
extends Object

Allows extending the project's build script with 3rd party additions. Check the Project's lookup to see if the feature is supported by a given Ant project type. Typical usage:

Lookup the instance of AntBuildExtender in the project at hand
Create the external build script file with your targets and configuration
Use the AntBuildExtender to wire your script and targets into the main build lifecycle
Call ProjectManager.saveProject(org.netbeans.api.project.Project) to persist the changes and regenerate the main build script

Please note that it's easy to break the build script functionality and any script extensions shall be done with care. A few rules to follow:

Pick a reasonably unique extension id
Prefix target names and properties you define in your extension with the extension id to prevent clashes.

Since:: org.netbeans.modules.project.ant 1.16

Nested Class Summary

class AntBuildExtender.Extension
          Describes and allows to manipulate the build script extension and it's links to the main build script of the project.

Method Summary

AntBuildExtender.Extension addExtension(String id, FileObject extensionXml)
          Adds a new build script extension.

List<String> getExtensibleTargets()
          Get a list of target names in the main build script that are allowed to be extended by adding the "depends" attribute definition to them.

AntBuildExtender.Extension getExtension(String id)
          Get an extension by the id.

void removeExtension(String id)
          Remove an existing build script extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Nested Class Summary
`class`	`AntBuildExtender.Extension` Describes and allows to manipulate the build script extension and it's links to the main build script of the project.

Method Summary
`AntBuildExtender.Extension`	`addExtension(String id, FileObject extensionXml)` Adds a new build script extension.
`List<String>`	`getExtensibleTargets()` Get a list of target names in the main build script that are allowed to be extended by adding the "depends" attribute definition to them.
`AntBuildExtender.Extension`	`getExtension(String id)` Get an extension by the id.
`void`	`removeExtension(String id)` Remove an existing build script extension.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getExtensibleTargets

public List<String> getExtensibleTargets()

Get a list of target names in the main build script that are allowed to be extended by adding the "depends" attribute definition to them.

Returns:: list of target names

addExtension

public AntBuildExtender.Extension addExtension(String id,
                                               FileObject extensionXml)

Adds a new build script extension.

Parameters:: id - identification of the extension; extensionXml - fileobject referencing the build script for the extension, needs to be located in nbproject directory or below.
Returns:: the newly created extension.

removeExtension

public void removeExtension(String id)

Remove an existing build script extension. Make sure to remove the extension's script file before/after removing the extension.

Parameters:: id - identification of the extension

getExtension

public AntBuildExtender.Extension getExtension(String id)

Get an extension by the id.

Parameters:: id - identification token
Returns:: Extention with the given id or null if not found.