Ant-Based Project Support
Official

AntProjectAPI

See:
Description

Ant-Based Project Support

org.netbeans.api.project.ant	Ways of getting information about Ant-based projects useful from other projects.
org.netbeans.spi.project.ant	Pluggable implementations of inter-project Ant dependencies.
org.netbeans.spi.project.support.ant	Principal package for implementing typical Ant-based projects.
org.netbeans.spi.project.support.ant.ui	Package containing classes supporting development of UI for Ant-based projects.

AntProjectAPI

Mostly an SPI for creating project types centered around the Ant build tool. Permits Ant-based project types to be registered and supplies various support implementations to help satisfy the contract of Project and various optional interfaces.

What is New (see all changes)?

• Aug 27 '08 Enhance AntArtifact support with ability to specify build.xml location and name

  AntProjectHelper.createSimpleAntArtifact enhanced with new parameter: property name holding project relative location and name of Ant build script to use.

• Jul 11 '08 Project XML metadata automatically validated against schemas

  XML schemas may now be registered in ProjectXMLCatalog/**/*.xsd. Any attempts to read or write project.xml or private.xml will first try to validate against the registered schemas.

• Jun 12 '08 Support for (IDE) variables in Ant based project types

  FileChooser enhanced with "Use Variable Path" option. Following methods were added: FileChooser.getSelectedPathVariables and FileChooser.enableVariableBasedSelection. For backward compatibility "Use Variable Path" option is by default switched off and has to be enabled. Existing getSelectedPaths() method will keep returning either absolute or relative paths. If "Use Variable Path" option was selected it will return absolute path. Variable based paths are returned via new getSelectedPathVariables method.

  Support class added for showing variables manager.

• Jun 11 '08 Support for adding/copying libraries used by build process only

  Added methods for adding/copying global libraries that are needed for Ant build script. Added methods: AntBuildExtender.addLibrary, AntBuildExtender.removeLibrary

• Jun 9 '08 Added AntProjectHelper.createAuxiliaryProperties()

  A new API method AntProjectHelper.createAuxiliaryProperties.

Use Cases

Mostly an SPI for use by project type providers to create the project type. Also includes a small API/SPI for other projects to find what Ant build steps are necessary to create a certain build product, for use in inter-project dependencies.

Ant project support faq:

How to use support for storing project properties?

Q: I'm creating a customizer (properties dialog) for my project type. I wan't to use the support for simple data types. What do I need to do?

You basicaly need to do two things. First create the representation of the project properties which can be used in the GUI. Second at some time convert the objects back to the ANT properties form and store them into the project.

• Creating the object representation.
  1. Create new instance of StoreGroup for each group of properties you want to store later e.g. project and prvate. Sometimes it might be useful to create temporary source group which will only be used for creating the models without being used for storing. E.g. for properties which need special handling.
  2. Call the factory methods e.g. createBooleanButtonModel, createStringDocument, etc. which will create the swing models for you.
  3. Use the models in your Swing controls by calling setModel() or setDocument()
• Storing the models back to the proprties of project.
  1. Get the EditableProperties you want to store the model in e.g. private or project properties
  2. Call the store method on given SourceGroup with the EditableProperties as parameter
  3. Manually store models which need some special handling.

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?
AntProjectAPI	Exported	Official	Mostly an SPI for creating project types centered around the Ant build tool. Permits Ant-based project types to be registered and supplies various support implementations to help satisfy the contract of Project and various optional interfaces.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
netbeans.do.not.check.xalan	Exported	Private	The "netbeans.do.not.check.xalan" property switches off the startup check for buggy Xalan. See issue #70130 for more information.

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.