xjavadoc.ant
Class XJavadocTask

java.lang.Object
  extended byTask
      extended byxjavadoc.ant.XJavadocTask

public abstract class XJavadocTask
extends Task

This class should be subclassed to be used for XDocletImpl, revXDoclet etc.

Author:
Aslak Hellesøy, Ara Abrahamian
See Also:
Serialized Form

Field Summary
private  java.util.LinkedList _fileSets
           
private  XJavaDoc _xJavaDoc
           
 
Constructor Summary
XJavadocTask()
           
 
Method Summary
 void addFileset(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)
           
 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 setSourcepath(Path path)
          Deprecated. This method will disappear soon
 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_xJavaDoc

private final XJavaDoc _xJavaDoc

_fileSets

private final java.util.LinkedList _fileSets
Constructor Detail

XJavadocTask

public XJavadocTask()
Method Detail

setSourcepath

public void setSourcepath(Path path)
Deprecated. This method will disappear soon

Parameters:
path -

getXJavaDoc

protected XJavaDoc getXJavaDoc()

setIgnoredtags

public void setIgnoredtags(java.lang.String tags)
Sets the tags to ignore if validation is true. The value should be a comma-separated list of tag names (without the tag name)

Parameters:
tags - tags that should be ignored when doing validation.

setValidating

public void setValidating(boolean flag)
Sets whether or not tags will be validated.

Parameters:
flag -

setEncoding

public void setEncoding(java.lang.String enc)
set source file charset


setDocencoding

public void setDocencoding(java.lang.String enc)

execute

public final void execute()
                   throws BuildException
Implementation of Ant's Task.execute().

Throws:
BuildException - Ant's way or reporting build exception

createIgnoredtag

public java.lang.Object createIgnoredtag()
Ignores one tag

Returns:

addFileset

public void addFileset(FileSet set)
Ant's <fileset> definition. To define the files to parse.

Parameters:
set - a fileset to add

getClasspath

protected java.lang.String getClasspath()
Returns the classpath

Returns:
the classpath

start

protected abstract void start()
                       throws BuildException
Implement this method and play with _xJavaDoc

Throws:
BuildException - Ant's way of reporting exception

validateOptions

protected void validateOptions()
                        throws BuildException
Validate a Xdoclet task before running it.

Throws:
BuildException - in case the validation fails.