org.apache.tools.ant.taskdefs
Class Javadoc.TagArgument
- Javadoc
- Cloneable, SelectorContainer
public class Javadoc.TagArgument
Class representing a -tag argument.
String | getParameter() - Returns the -tag parameter this argument represented.
|
void | setDescription(String description) - Sets the description of the tag.
|
void | setEnabled(boolean enabled) - Sets whether or not the tag is enabled.
|
void | setName(String name) - Sets the name of the tag.
|
void | setScope(String verboseScope) - Sets the scope of the tag.
|
add , addAnd , addContains , addContainsRegexp , addCustom , addDate , addDepend , addDepth , addDifferent , addFilename , addMajority , addModified , addNone , addNot , addOr , addPresent , addSelector , addSize , addType , appendSelector , clone , createExclude , createExcludesFile , createInclude , createIncludesFile , createPatternSet , getDataTypeName , getDefaultexcludes , getDir , getDirectoryScanner , getRef , getSelectors , hasPatterns , hasSelectors , isFollowSymlinks , selectorCount , selectorElements , setCaseSensitive , setDefaultexcludes , setDir , setExcludes , setExcludesfile , setFile , setFollowSymlinks , setIncludes , setIncludesfile , setRefid , setupDirectoryScanner , toString |
checkAttributesAllowed , checkChildrenAllowed , circularReference , dieOnCircularReference , getCheckedRef , getDescription , getRefid , isChecked , isReference , noChildrenAllowed , setChecked , setDescription , setRefid , tooManyAttributes |
TagArgument
public TagArgument()
Sole constructor.
getParameter
public String getParameter()
throws BuildException
Returns the -tag parameter this argument represented.
setDescription
public void setDescription(String description)
Sets the description of the tag. This is what appears in
the JavaDoc.
- setDescription in interface DataType
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.
enabled
- Whether or not this tag is enabled.
setName
public void setName(String name)
Sets the name of the tag.
name
- The name of the tag.
Must not be null
or empty.
setScope
public void setScope(String verboseScope)
throws BuildException
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.
verboseScope
- The scope of the tag.
Must not be null
,
should not be empty.
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 B) 2000-2006 Apache Software Foundation. All Rights Reserved.