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:
Cloneable, Iterable<Resource>, ResourceCollection, SelectorContainer
Enclosing class:
Javadoc
public class Javadoc.TagArgument extends FileSet
Class representing a -tag argument.
Since:
Ant 1.1

  • Constructor Details

    • TagArgument

      public TagArgument()
      Sole constructor.

  • Method Details

    • 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) 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 String getParameter() throws BuildException
      Returns the -tag parameter this argument represented.
      Returns:
      the -tag parameter as a string
      Throws:
      BuildException - if either the name or description is null or empty.