xdoclet.sdk.ant
Class BuildXmlMetadataProvider

java.lang.Object
  |
  +--xdoclet.sdk.ant.BuildXmlMetadataProvider

All Implemented Interfaces:

MetadataProvider

public final class BuildXmlMetadataProvider

extends Object

implements MetadataProvider

MetadataProvider that can be used to generate simple build.xml files from a given configuration of XDoclet.

Version:

$Revision: 1.1 $

Author:

Aslak Hellesøy

Constructor Summary

BuildXmlMetadataProvider()

Method Summary

void	cleanup() Frees any resources and does any other necessary work before shutting down.
Collection	createMetadataCollection() Returns a Collection of objects that should be used as basis for code generation.
String	getFilenameSubstitutionValue(Object o) Returns the string that will be replaced in the {0} part of the file name.
String	getPackageName(Object o) Returns the package name that will be used to determine the file name.
void	setClasspath(String classpath) Sets the classpath.
void	setXDoclet(XDoclet xdoclet)

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildXmlMetadataProvider

public BuildXmlMetadataProvider()

Method Detail

setXDoclet

public void setXDoclet(XDoclet xdoclet)

createMetadataCollection

public Collection createMetadataCollection()
                                    throws XDocletException

Description copied from interface: MetadataProvider

Returns a Collection of objects that should be used as basis for code generation. It's up to the Plugins to handle the elements in the Collection. Special Plugins will expect the elements in the Collection to be of a certain type.

Specified by:

createMetadataCollection in interface MetadataProvider

Returns:

Collection of arbitrary objects

XDocletException

getFilenameSubstitutionValue

public String getFilenameSubstitutionValue(Object o)

Description copied from interface: MetadataProvider

Returns the string that will be replaced in the {0} part of the file name.

Specified by:

getFilenameSubstitutionValue in interface MetadataProvider

Parameters:

o - the object the substitution string should be derived from.

Returns:

the substitution string.

getPackageName

public String getPackageName(Object o)

Description copied from interface: MetadataProvider

Returns the package name that will be used to determine the file name.

Specified by:

getPackageName in interface MetadataProvider

Parameters:

o - the object from which the package name is derived.

Returns:

the package name to use for o.

cleanup

public void cleanup()

Description copied from interface: MetadataProvider

Frees any resources and does any other necessary work before shutting down.

Specified by:

cleanup in interface MetadataProvider

setClasspath

public void setClasspath(String classpath)
                  throws XDocletException

Description copied from interface: MetadataProvider

Sets the classpath. This is useful for some implementations that need to load additional classes or resources from the classpath.

Specified by:

setClasspath in interface MetadataProvider

XDocletException