xdoclet.xjavadoc
Class XJavadocMetadataProvider

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--xdoclet.xjavadoc.XJavadocMetadataProvider

All Implemented Interfaces:

MetadataProvider

public class XJavadocMetadataProvider

extends ProjectComponent

implements MetadataProvider

MetadataProvider implementation that returns XClass.

Version:

$Revision: 1.10 $

Author:

Aslak Hellesøy

Field Summary

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

XJavadocMetadataProvider()

Method Summary

void	addFileset(FileSet fileSet) Ant's <fileset> definition.
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. 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.
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.
XJavaDoc	getXJavaDoc()
void	setClasspath(String classpath) Sets the classpath.
void	setIgnoredtags(String tags) Sets the tags to ignore if validation is true.
void	setValidating(boolean flag) Sets whether or not tags will be validated.

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

XJavadocMetadataProvider

public XJavadocMetadataProvider()

Method Detail

addFileset

public void addFileset(FileSet fileSet)

Ant's <fileset> definition. To define the files to parse.

Parameters:

fileSet - a fileset to add

getXJavaDoc

public XJavaDoc getXJavaDoc()

setIgnoredtags

public void setIgnoredtags(String tags)

Sets the tags to ignore if validation is true. The value should be a comma-separated list of tag names (without the tag name)

Parameters:

tags - tags that should be ignored when doing validation.

setValidating

public void setValidating(boolean flag)

Sets whether or not tags will be validated.

Parameters:

flag -

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

createMetadataCollection

public final Collection createMetadataCollection()
                                          throws XDocletException

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:

a Collection of XClass.

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()
             throws XDocletException

Description copied from interface: MetadataProvider

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

Specified by:

cleanup in interface MetadataProvider

XDocletException