org.apache.tools.ant.taskdefs

Class Javadoc.TagArgument

public class Javadoc.TagArgument extends FileSet

Class representing a -tag argument.
Constructor Summary
TagArgument()
Sole constructor.
Method Summary
StringgetParameter()
Returns the -tag parameter this argument represented.
voidsetDescription(String description)
Sets the description of the tag.
voidsetEnabled(boolean enabled)
Sets whether or not the tag is enabled.
voidsetName(String name)
Sets the name of the tag.
voidsetScope(String verboseScope)
Sets the scope of the tag.

Constructor Detail

TagArgument

public TagArgument()
Sole constructor.

Method Detail

getParameter

public String getParameter()
Returns the -tag parameter this argument represented.

Throws: BuildException if either the name or description is null or empty.

setDescription

public void setDescription(String description)
Sets the description of the tag. This is what appears in the JavaDoc.

Parameters: description The description of the tag. Must not be null or empty.

setEnabled

public void setEnabled(boolean enabled)
Sets whether or not the tag is enabled.

Parameters: enabled Whether or not this tag is enabled.

setName

public void setName(String name)
Sets the name of the tag.

Parameters: name The name of the tag. Must not be null or empty.

setScope

public void setScope(String verboseScope)
Sets the scope of the tag. This is in comma-separated form, with each element being one of "all" (the default), "overview", "packages", "types", "constructors", "methods", "fields". The elements are treated in a case-insensitive manner.

Parameters: verboseScope The scope of the tag. Must not be null, should not be empty.

Throws: BuildException if all is specified along with other elements, if any elements are repeated, if no elements are specified, or if any unrecognised elements are specified.

Copyright