org.netbeans.spi.project.support.ant

Annotation Type AntBasedProjectRegistration

@Retention(value=SOURCE)
 @Target(value={TYPE,METHOD})
public @interface AntBasedProjectRegistration

Registers a Project implementation as an AntBasedProjectType extension. Just write a project with constructor that takes one AntProjectHelper argument and annotate the class with this annotation. As an alternative you can annotate a factory method with the same parameter.

Since:

1.30

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	iconResource icon of the project type represented by the given implementation of the interface.
String	privateNamespace Get the namespace of the XML element that should be used to store the project's specific configuration data in nbproject/private/private.xml (inside <project-private>).
String	sharedNamespace Get the namespace of the XML element that should be used to store the project's specific configuration data in nbproject/project.xml (inside <configuration>).
String	type Get a unique type identifier for this kind of project.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	privateName Get the simple name of the XML element that should be used to store the project's specific configuration data in nbproject/private/private.xml (inside <project-private>).
String	sharedName Get the simple name of the XML element that should be used to store the project's specific configuration data in nbproject/project.xml (inside <configuration>).

Element Detail

iconResource

public abstract String iconResource

icon of the project type represented by the given implementation of the interface.

Returns:

the ClassLoader.getResource(java.lang.String) path to the icon

type

public abstract String type

Get a unique type identifier for this kind of project. No two registered AntBasedProjectType instances may share the same type. The type is stored in nbproject/project.xml in the type element. It is forbidden for the result of this method to change from call to call.

Returns:

the project type

sharedNamespace

public abstract String sharedNamespace

Get the namespace of the XML element that should be used to store the project's specific configuration data in nbproject/project.xml (inside <configuration>).

Returns:

an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project or http://www.netbeans.org/ns/j2se-project-private

privateNamespace

public abstract String privateNamespace

Get the namespace of the XML element that should be used to store the project's specific configuration data in nbproject/private/private.xml (inside <project-private>).

Returns:

an XML namespace, e.g. http://www.netbeans.org/ns/j2se-project or http://www.netbeans.org/ns/j2se-project-private

sharedName

public abstract String sharedName

Get the simple name of the XML element that should be used to store the project's specific configuration data in nbproject/project.xml (inside <configuration>).

Returns:

a simple name; data is recommended but not required

Default:

"data"

privateName

public abstract String privateName

Get the simple name of the XML element that should be used to store the project's specific configuration data in nbproject/private/private.xml (inside <project-private>).

Returns:

a simple name; data is recommended but not required

Default:

"data"