Javadoc.TagArgument (Apache Ant API)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.taskdefs.Javadoc.TagArgument
Class representing a -tag argument.
Constructor Summary | |
Javadoc.TagArgument()
Sole constructor. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Javadoc.TagArgument()
Method Detail |
public void setName(java.lang.String name)
name
- The name of the tag.
Must not be null
or empty.public void setDescription(java.lang.String description)
description
- The description of the tag.
Must not be null
or empty.public void setScope(java.lang.String verboseScope) throws BuildException
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.public void setEnabled(boolean enabled)
enabled
- Whether or not this tag is enabled.public java.lang.String getParameter() throws BuildException
BuildException
- if either the name or description
is null
or empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |