xjavadoc.ant
Class XJavadocTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by xjavadoc.ant.XJavadocTask
All Implemented Interfaces:
java.lang.Cloneable

public abstract class XJavadocTask
extends org.apache.tools.ant.Task

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

Author:
Aslak Helles?y, Ara Abrahamian

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

_xJavaDoc

private final XJavaDoc _xJavaDoc

_fileSets

private final java.util.LinkedList _fileSets
Constructor Detail

XJavadocTask

public XJavadocTask()
Method Detail

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 - validate?

setEncoding

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

Parameters:
enc - the encoding

setDocencoding

public void setDocencoding(java.lang.String enc)
set generated file charset

Parameters:
enc - the encoding

execute

public final void execute()
                   throws org.apache.tools.ant.BuildException
Implementation of Ant's Task.execute().

Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException - Ant's way of reporting build exception

createIgnoredtag

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

Returns:

addFileset

public void addFileset(org.apache.tools.ant.types.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 org.apache.tools.ant.BuildException
Implement this method and play with _xJavaDoc

Throws:
org.apache.tools.ant.BuildException - Ant's way of reporting exception

validateOptions

protected void validateOptions()
                        throws org.apache.tools.ant.BuildException
Validate a Xdoclet task before running it.

Throws:
org.apache.tools.ant.BuildException - in case the validation fails.