Package org.aspectj.tools.ant.taskdefs

Class Ajdoc

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

org.aspectj.tools.ant.taskdefs.Ajdoc

All Implemented Interfaces:

org.apache.tools.ant.types.selectors.SelectorContainer

public class Ajdoc
extends org.apache.tools.ant.taskdefs.MatchingTask

A task to run the ajdoc tool.

Author:

Jeff Palm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Ajdoc.Doclet
class	Ajdoc.Group
class	Ajdoc.Link
protected static interface	Ajdoc.Mapper<T>
static class	Ajdoc.Param

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AJDOC_CLASSNAME	The name of ajdoc class we're using.
protected org.apache.tools.ant.types.Commandline	cmd
static final boolean	FORCE_FORK	If true, ignore fork param and use FORCE_FORK_VALUE
static final boolean	FORCE_FORK_VALUE	value used as fork when FORCE_FORK is true
protected org.apache.tools.ant.types.Commandline	vmcmd

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

Constructors

Constructor	Description
Ajdoc()	reset all to initial values - permit gc if Ajdoc is held

Method Summary

Modifier and Type	Method	Description
void	addBottom(org.apache.tools.ant.taskdefs.Javadoc.Html text)
void	addFileset(org.apache.tools.ant.types.FileSet fs)
protected final boolean	check(File file, String name, boolean isDir, org.apache.tools.ant.Location loc)
protected int	compile()
List<File>	createArgfiles()
org.apache.tools.ant.types.Path	createBootclasspath()
org.apache.tools.ant.types.Path	createClasspath()
Ajdoc.Doclet	createDoclet()
org.apache.tools.ant.types.Path	createDocletpath()
Ajdoc.Group	createGroup()
org.apache.tools.ant.types.Path	createInternalclasspath()
org.apache.tools.ant.types.Commandline.Argument	createJvmarg()
Ajdoc.Link	createLink()
org.apache.tools.ant.types.Path	createSourcepath()
org.apache.tools.ant.types.Path	createSrcdir()
void	execute()
protected final List<File>	files(String str)
protected final String	filterSlashes(String str)
protected final <T> List<T>	list(String str, Ajdoc.Mapper<T> mapper)
protected void	reset()
protected final void	set(String flag, String val)
void	setAccess(org.apache.tools.ant.taskdefs.Javadoc.AccessType at)
void	setAdditionalparam(String additionalparam)
void	setArgfile(String argfile)
void	setArgfiles(String argfiles)
void	setAuthor(boolean author)
void	setBootclasspath(org.apache.tools.ant.types.Path path)
void	setBootclasspathref(org.apache.tools.ant.types.Reference bootclasspathref)
void	setBottom(String bottom)
void	setCharset(String charset)
void	setClasspath(org.apache.tools.ant.types.Path path)
void	setClasspathref(org.apache.tools.ant.types.Reference id)
void	setDestdir(String destdir)
void	setDocencoding(String docencoding)
void	setDoclet(String doclet)
void	setDocletpath(org.apache.tools.ant.types.Path path)
void	setDocletpathRef(org.apache.tools.ant.types.Reference id)
void	setDoctitle(String doctitle)
void	setExtdirs(org.apache.tools.ant.types.Path path)
void	setFailonerror(boolean failonerror)
protected final void	setfile(String flag, String file)
void	setFooter(String footer)
void	setFork(boolean fork)
void	setGroup(String str)
void	setHeader(String header)
void	setHelpfile(String helpfile)
protected final boolean	setif(boolean b, String flag)
protected final boolean	setif(boolean b, String flag, String val)
void	setInternalclasspath(org.apache.tools.ant.types.Path internalclasspath)
void	setInternalclasspathref(org.apache.tools.ant.types.Reference internalclasspathref)
void	setLink(String href)
void	setLinkoffline(String linkoffline)
void	setMaxmemory(String max)
void	setNodeprecated(boolean nodeprecated)
void	setNodeprecatedlist(boolean nodeprecatedlist)
void	setNohelp(boolean nohelp)
void	setNoindex(boolean noindex)
void	setNonavbar(boolean nonavbar)
void	setNotree(boolean notree)
void	setOld(boolean old)
void	setOverview(String overview)
void	setPackage(boolean b)
void	setPackageList(String packageList)
void	setPackagenames(String list)
void	setPrivate(boolean b)
void	setProtected(boolean b)
void	setPublic(boolean b)
void	setSerialwarn(boolean serialwarn)
void	setSource(String input)
void	setSourcefiles(String list)
void	setSourcepath(org.apache.tools.ant.types.Path path)
void	setSourcepathRef(org.apache.tools.ant.types.Reference id)
void	setSplitindex(boolean splitindex)
void	setSrcdir(org.apache.tools.ant.types.Path path)
void	setSrcdirRef(org.apache.tools.ant.types.Reference id)
void	setStandard(boolean b)
void	setStylesheetfile(String stylesheetfile)
void	setUse(boolean b)
void	setVerbose(boolean b)
void	setVersion(boolean b)
void	setWindowtitle(String windowtitle)
protected final List<String>	strings(String str)
protected final List<String>	strings(String str, boolean filterSlashes)

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

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, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

getProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AJDOC_CLASSNAME

public static final String AJDOC_CLASSNAME

The name of ajdoc class we're using.

See Also:

• Constant Field Values

FORCE_FORK

public static final boolean FORCE_FORK

If true, ignore fork param and use FORCE_FORK_VALUE

See Also:

• Constant Field Values

FORCE_FORK_VALUE

public static final boolean FORCE_FORK_VALUE

value used as fork when FORCE_FORK is true

See Also:

• Constant Field Values

cmd

protected org.apache.tools.ant.types.Commandline cmd

vmcmd

protected org.apache.tools.ant.types.Commandline vmcmd

Constructor Details

Ajdoc

public Ajdoc()

reset all to initial values - permit gc if Ajdoc is held

Method Details

reset

protected void reset()

setif

protected final boolean setif(boolean b,
 String flag)

setfile

protected final void setfile(String flag,
 String file)

set

protected final void set(String flag,
 String val)

setif

protected final boolean setif(boolean b,
 String flag,
 String val)

setSource

public void setSource(String input)

setSourcepath

public void setSourcepath(org.apache.tools.ant.types.Path path)

createSourcepath

public org.apache.tools.ant.types.Path createSourcepath()

setSourcepathRef

public void setSourcepathRef(org.apache.tools.ant.types.Reference id)

setSrcdir

public void setSrcdir(org.apache.tools.ant.types.Path path)

createSrcdir

public org.apache.tools.ant.types.Path createSrcdir()

setSrcdirRef

public void setSrcdirRef(org.apache.tools.ant.types.Reference id)

setDestdir

public void setDestdir(String destdir)

setSourcefiles

public void setSourcefiles(String list)

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet fs)

setPackagenames

public void setPackagenames(String list)

setAccess

public void setAccess(org.apache.tools.ant.taskdefs.Javadoc.AccessType at)

setPackageList

public void setPackageList(String packageList)

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path path)

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

setClasspathref

public void setClasspathref(org.apache.tools.ant.types.Reference id)

setBootclasspath

public void setBootclasspath(org.apache.tools.ant.types.Path path)

createBootclasspath

public org.apache.tools.ant.types.Path createBootclasspath()

setBootclasspathref

public void setBootclasspathref(org.apache.tools.ant.types.Reference bootclasspathref)

setInternalclasspath

public void setInternalclasspath(org.apache.tools.ant.types.Path internalclasspath)

createInternalclasspath

public org.apache.tools.ant.types.Path createInternalclasspath()

setInternalclasspathref

public void setInternalclasspathref(org.apache.tools.ant.types.Reference internalclasspathref)

setExtdirs

public void setExtdirs(org.apache.tools.ant.types.Path path)

createArgfiles

public List<File> createArgfiles()

setArgfile

public void setArgfile(String argfile)

setArgfiles

public void setArgfiles(String argfiles)

setOverview

public void setOverview(String overview)

setPublic

public void setPublic(boolean b)

setPackage

public void setPackage(boolean b)

setProtected

public void setProtected(boolean b)

setPrivate

public void setPrivate(boolean b)

setOld

public void setOld(boolean old)

setAuthor

public void setAuthor(boolean author)

setSplitindex

public void setSplitindex(boolean splitindex)

setWindowtitle

public void setWindowtitle(String windowtitle)

setDoctitle

public void setDoctitle(String doctitle)

setHeader

public void setHeader(String header)

setFooter

public void setFooter(String footer)

setBottom

public void setBottom(String bottom)

addBottom

public void addBottom(org.apache.tools.ant.taskdefs.Javadoc.Html text)

setVerbose

public void setVerbose(boolean b)

setVersion

public void setVersion(boolean b)

setUse

public void setUse(boolean b)

setStandard

public void setStandard(boolean b)

setLink

public void setLink(String href)

createLink

public Ajdoc.Link createLink()

setLinkoffline

public void setLinkoffline(String linkoffline)

setGroup

public void setGroup(String str)

createGroup

public Ajdoc.Group createGroup()

setNodeprecated

public void setNodeprecated(boolean nodeprecated)

setNodeprecatedlist

public void setNodeprecatedlist(boolean nodeprecatedlist)

setNotree

public void setNotree(boolean notree)

setNoindex

public void setNoindex(boolean noindex)

setNohelp

public void setNohelp(boolean nohelp)

setNonavbar

public void setNonavbar(boolean nonavbar)

setSerialwarn

public void setSerialwarn(boolean serialwarn)

setHelpfile

public void setHelpfile(String helpfile)

setStylesheetfile

public void setStylesheetfile(String stylesheetfile)

setCharset

public void setCharset(String charset)

setDocencoding

public void setDocencoding(String docencoding)

setDoclet

public void setDoclet(String doclet)

createDoclet

public Ajdoc.Doclet createDoclet()

setDocletpath

public void setDocletpath(org.apache.tools.ant.types.Path path)

createDocletpath

public org.apache.tools.ant.types.Path createDocletpath()

setDocletpathRef

public void setDocletpathRef(org.apache.tools.ant.types.Reference id)

setAdditionalparam

public void setAdditionalparam(String additionalparam)

setFailonerror

public void setFailonerror(boolean failonerror)

setFork

public void setFork(boolean fork)

createJvmarg

public org.apache.tools.ant.types.Commandline.Argument createJvmarg()

setMaxmemory

public void setMaxmemory(String max)

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

compile

protected int compile()
               throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

list

protected final <T> List<T> list(String str,
 Ajdoc.Mapper<T> mapper)

files

protected final List<File> files(String str)

strings

protected final List<String> strings(String str)

strings

protected final List<String> strings(String str,
 boolean filterSlashes)

filterSlashes

protected final String filterSlashes(String str)

check

protected final boolean check(File file,
 String name,
 boolean isDir,
 org.apache.tools.ant.Location loc)