|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
xjavadoc.ant.XJavadocTask
This class should be subclassed to be used for XDocletImpl, revXDoclet etc.
Field Summary | |
private java.util.LinkedList |
_fileSets
|
private XJavaDoc |
_xJavaDoc
|
Fields inherited from class org.apache.tools.ant.Task |
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
description, location, project |
Constructor Summary | |
XJavadocTask()
|
Method Summary | |
void |
addFileset(org.apache.tools.ant.types.FileSet set)
Ant's <fileset> definition. |
java.lang.Object |
createIgnoredtag()
Ignores one tag |
void |
execute()
Implementation of Ant's Task.execute() . |
protected java.lang.String |
getClasspath()
Returns the classpath |
protected XJavaDoc |
getXJavaDoc()
|
void |
setDocencoding(java.lang.String enc)
set generated file charset |
void |
setEncoding(java.lang.String enc)
set source file charset |
void |
setIgnoredtags(java.lang.String tags)
Sets the tags to ignore if validation is true. |
void |
setValidating(boolean flag)
Sets whether or not tags will be validated. |
protected abstract void |
start()
Implement this method and play with _xJavaDoc |
protected void |
validateOptions()
Validate a Xdoclet task before running it. |
Methods inherited from class org.apache.tools.ant.Task |
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private final XJavaDoc _xJavaDoc
private final java.util.LinkedList _fileSets
Constructor Detail |
public XJavadocTask()
Method Detail |
protected XJavaDoc getXJavaDoc()
public void setIgnoredtags(java.lang.String tags)
tags
- tags that should be ignored when doing validation.public void setValidating(boolean flag)
flag
- validate?public void setEncoding(java.lang.String enc)
enc
- the encodingpublic void setDocencoding(java.lang.String enc)
enc
- the encodingpublic final void execute() throws org.apache.tools.ant.BuildException
Task.execute()
.
org.apache.tools.ant.BuildException
- Ant's way of reporting build exceptionpublic java.lang.Object createIgnoredtag()
public void addFileset(org.apache.tools.ant.types.FileSet set)
set
- a fileset to addprotected java.lang.String getClasspath()
protected abstract void start() throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
- Ant's way of reporting exceptionprotected void validateOptions() throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
- in case the validation fails.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |