org.apache.tools.ant.taskdefs
Class Javadoc.TagArgument
java.lang.Object
|
+--org.apache.tools.ant.ProjectComponent
|
+--org.apache.tools.ant.types.DataType
|
+--org.apache.tools.ant.types.AbstractFileSet
|
+--org.apache.tools.ant.types.FileSet
|
+--org.apache.tools.ant.taskdefs.Javadoc.TagArgument
- All Implemented Interfaces:
- java.lang.Cloneable, SelectorContainer
- Enclosing class:
- Javadoc
- public class Javadoc.TagArgument
- extends FileSet
Class representing a -tag argument.
Method Summary |
java.lang.String |
getParameter()
Returns the -tag parameter this argument represented. |
void |
setDescription(java.lang.String description)
Sets the description of the tag. |
void |
setEnabled(boolean enabled)
Sets whether or not the tag is enabled. |
void |
setName(java.lang.String name)
Sets the name of the tag. |
void |
setScope(java.lang.String verboseScope)
Sets the scope of the tag. |
Methods inherited from class org.apache.tools.ant.types.FileSet |
clone |
Methods inherited from class org.apache.tools.ant.types.AbstractFileSet |
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, 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 |
Methods inherited from class org.apache.tools.ant.types.DataType |
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, tooManyAttributes |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Javadoc.TagArgument
public Javadoc.TagArgument()
- Sole constructor.
setName
public void setName(java.lang.String name)
- Sets the name of the tag.
- Parameters:
name
- The name of the tag.
Must not be null
or empty.
setDescription
public void setDescription(java.lang.String description)
- Sets the description of the tag. This is what appears in
the JavaDoc.
- Overrides:
setDescription
in class DataType
- Parameters:
description
- The description of the tag.
Must not be null
or empty.
setScope
public void setScope(java.lang.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.
- 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.
setEnabled
public void setEnabled(boolean enabled)
- Sets whether or not the tag is enabled.
- Parameters:
enabled
- Whether or not this tag is enabled.
getParameter
public java.lang.String getParameter()
throws BuildException
- Returns the -tag parameter this argument represented.
- Throws:
BuildException
- if either the name or description
is null
or empty.
Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.