Package 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:
- Cloneable,- Iterable<Resource>,- ResourceCollection,- SelectorContainer
- Enclosing class:
- Javadoc
Class representing a -tag argument.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionReturns the -tag parameter this argument represented.voidsetEnabled(boolean enabled) Sets whether or not the tag is enabled.voidSets the name of the tag.voidSets the scope of the tag.Methods inherited from class org.apache.tools.ant.types.FileSetclone, getRef, isFilesystemOnly, iterator, sizeMethods inherited from class org.apache.tools.ant.types.AbstractFileSetadd, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addExecutable, addFilename, addMajority, addModified, addNone, addNot, addOr, addOwnedBy, addPosixGroup, addPosixPermissions, addPresent, addReadable, addSelector, addSize, addSymlink, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toStringMethods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.IterableforEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
- 
Constructor Details- 
TagArgumentpublic TagArgument()Sole constructor.
 
- 
- 
Method Details- 
setNameSets the name of the tag.- Parameters:
- name- The name of the tag. Must not be- nullor empty.
 
- 
setScopeSets 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.
 
- 
setEnabledpublic void setEnabled(boolean enabled) Sets whether or not the tag is enabled.- Parameters:
- enabled- Whether or not this tag is enabled.
 
- 
getParameterReturns the -tag parameter this argument represented.- Returns:
- the -tag parameter as a string
- Throws:
- BuildException- if either the name or description is- nullor empty.
 
 
-