Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.taskdefs

Class Javadoc.TagArgument

Enclosing Class:
Javadoc
Implemented Interfaces:
Cloneable, SelectorContainer
public class Javadoc.TagArgument
extends FileSet
Class representing a -tag argument.

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

TagArgument()
Sole constructor.

Method Summary

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.

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, 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

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

TagArgument

public TagArgument()
Sole constructor.

Method Details

getParameter

public String getParameter()
            throws BuildException
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.
Overrides:
setDescription in interface DataType
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)
            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.

Overview Package Tree Index Deprecated About
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.