net.sf.xdc
Class XdcTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          net.sf.xdc.XdcTask

public class XdcTask

extends org.apache.tools.ant.Task

The XdcTask is a task for the Apache Ant build system. It resembles the Javadoc task in many of the two systems' common attributes.

Since:

0.5

Version:

0.5

Author:

Jens Voß

Field Summary

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

XdcTask()

Method Summary

void	addBottom(org.apache.tools.ant.taskdefs.Javadoc.Html bottom) Alternative setter method for this XdcTask's bottom attribute.
void	addDoctitle(org.apache.tools.ant.taskdefs.Javadoc.Html doctitle) Alternative setter method for this XdcTask's doctitle attribute.
void	addFooter(org.apache.tools.ant.taskdefs.Javadoc.Html footer) Alternative setter method for this XdcTask's footer attribute.
void	addHeader(org.apache.tools.ant.taskdefs.Javadoc.Html header) Alternative setter method for this XdcTask's header attribute.
org.apache.tools.ant.types.Commandline.Argument	createArg() Getter method for a new argument to be passed to this XdcTask.
org.apache.tools.ant.types.Path	createClasspath() Getter method for this XdcTask's classpath.
org.apache.tools.ant.types.Commandline.Argument	createJvmarg() Getter method for a new Java VM argument to be passed to this XdcTask.
org.apache.tools.ant.types.Path	createSourcepath() Getter method for this XdcTask's source path.
void	execute() This method executes this XdcTask.
void	setAuthor(boolean author) Setter method for this XdcTask's author attribute.
void	setBottom(java.lang.String bottom) Setter method for this XdcTask's bottom attribute.
void	setCharset(java.lang.String charset) Setter method for this XdcTask's charset attribute.
void	setClasspath(org.apache.tools.ant.types.Path path) Setter method for this XdcTask's classpath.
void	setClasspathRef(org.apache.tools.ant.types.Reference r) Setter method for this XdcTask's classpathref.
void	setDefaultexcludes(boolean defaultexcludes) Setter method for this XdcTask's defaultexcludes attribute.
void	setDestdir(java.io.File destdir) Setter method for this XdcTask's destination directory.
void	setDialect(java.lang.String dialect) Setter method for this XdcTask's dialect attribute.
void	setDialectmapping(java.io.File dialectmapping) Setter method for this XdcTask's dialectmapping attribute.
void	setDialects(java.io.File dialects) Setter method for this XdcTask's dialects attribute.
void	setDocencoding(java.lang.String docencoding) Setter method for this XdcTask's docencoding attribute.
void	setDoctitle(java.lang.String doctitle) Setter method for this XdcTask's doctitle attribute.
void	setEncoding(java.lang.String encoding) Setter method for this XdcTask's encoding attribute.
void	setExtensions(java.lang.String extensions) Setter method for this XdcTask's extensions attribute.
void	setFooter(java.lang.String footer) Setter method for this XdcTask's footer attribute.
void	setHeader(java.lang.String header) Setter method for this XdcTask's header attribute.
void	setHelpfile(java.io.File helpfile) Setter method for this XdcTask's helpfile attribute.
void	setLinksource(boolean linksource) Setter method for this XdcTask's linksource attribute.
void	setLocale(java.lang.String locale) Setter method for this XdcTask's locale attribute.
void	setNosince(boolean nosince) Setter method for this XdcTask's nosince attribute.
void	setNotimestamp(boolean notimestamp) Setter method for this XdcTask's notimestamp attribute.
void	setOverview(java.io.File overview) Setter method for this XdcTask's overview attribute.
void	setReportmissing(boolean reportmissing) Setter method for this XdcTask's reportmissing attribute.
void	setSourcepath(org.apache.tools.ant.types.Path path) Setter method for this XdcTask's source path.
void	setSourcepathRef(org.apache.tools.ant.types.Reference r) Setter method for this XdcTask's source path reference.
void	setSubpackages(java.lang.String subpackages) Setter method for this XdcTask's subpackages attribute.
void	setVersion(boolean version) Setter method for this XdcTask's version attribute.
void	setWindowtitle(java.lang.String windowtitle) Setter method for this XdcTask's windowtitle attribute.

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, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

XdcTask

public XdcTask()

Method Detail

setClasspath

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

Setter method for this XdcTask's classpath. Appends the path to the existing one.

Parameters:

path - The new path to be appended

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)

Setter method for this XdcTask's classpathref.

Parameters:

r - The classpath reference to be set by this method

createClasspath

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

Getter method for this XdcTask's classpath.

Returns:

This XdcTask's classpath

setSourcepath

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

Setter method for this XdcTask's source path. Appends the path passed as parameter to the existing one.

Parameters:

path - The new path to be appended to the source path.

setSourcepathRef

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

Setter method for this XdcTask's source path reference.

Parameters:

r - The source path reference to be set by this method

createSourcepath

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

Getter method for this XdcTask's source path.

Returns:

This XdcTask's source path

setDestdir

public void setDestdir(java.io.File destdir)

Setter method for this XdcTask's destination directory.

Parameters:

destdir - The destination directory to be set

setSubpackages

public void setSubpackages(java.lang.String subpackages)

Setter method for this XdcTask's subpackages attribute.

Parameters:

subpackages - The subpackages attribute to be set

setNotimestamp

public void setNotimestamp(boolean notimestamp)

Setter method for this XdcTask's notimestamp attribute.

Parameters:

notimestamp - The notimestamp attribute to be set

setLinksource

public void setLinksource(boolean linksource)

Setter method for this XdcTask's linksource attribute.

Parameters:

linksource - The linksource attribute to be set

setDefaultexcludes

public void setDefaultexcludes(boolean defaultexcludes)

Setter method for this XdcTask's defaultexcludes attribute.

Parameters:

defaultexcludes - The defaultexcludes attribute to be set

setExtensions

public void setExtensions(java.lang.String extensions)

Setter method for this XdcTask's extensions attribute.

Parameters:

extensions - The extensions attribute to be set

setDialect

public void setDialect(java.lang.String dialect)

Setter method for this XdcTask's dialect attribute.

Parameters:

dialect - The dialect attribute to be set

setDialects

public void setDialects(java.io.File dialects)

Setter method for this XdcTask's dialects attribute.

Parameters:

dialects - The dialects attribute to be set

setDialectmapping

public void setDialectmapping(java.io.File dialectmapping)

Setter method for this XdcTask's dialectmapping attribute.

Parameters:

dialectmapping - The dialectmapping attribute to be set

setOverview

public void setOverview(java.io.File overview)

Setter method for this XdcTask's overview attribute.

Parameters:

overview - The overview attribute to be set

setHelpfile

public void setHelpfile(java.io.File helpfile)

Setter method for this XdcTask's helpfile attribute.

Parameters:

helpfile - The helpfile attribute to be set

setAuthor

public void setAuthor(boolean author)

Setter method for this XdcTask's author attribute.

Parameters:

author - The author attribute to be set

setNosince

public void setNosince(boolean nosince)

Setter method for this XdcTask's nosince attribute.

Parameters:

nosince - The nosince attribute to be set

setVersion

public void setVersion(boolean version)

Setter method for this XdcTask's version attribute.

Parameters:

version - The version attribute to be set

setWindowtitle

public void setWindowtitle(java.lang.String windowtitle)

Setter method for this XdcTask's windowtitle attribute.

Parameters:

windowtitle - The windowtitle attribute to be set

setDoctitle

public void setDoctitle(java.lang.String doctitle)

Setter method for this XdcTask's doctitle attribute.

Parameters:

doctitle - The doctitle attribute to be set

addDoctitle

public void addDoctitle(org.apache.tools.ant.taskdefs.Javadoc.Html doctitle)

Alternative setter method for this XdcTask's doctitle attribute.

Parameters:

doctitle - The doctitle (in HTML format) to be set

setHeader

public void setHeader(java.lang.String header)

Setter method for this XdcTask's header attribute.

Parameters:

header - The header attribute to be set

addHeader

public void addHeader(org.apache.tools.ant.taskdefs.Javadoc.Html header)

Alternative setter method for this XdcTask's header attribute.

Parameters:

header - The header (in HTML format) to be set

setFooter

public void setFooter(java.lang.String footer)

Setter method for this XdcTask's footer attribute.

Parameters:

footer - The footer attribute to be set

addFooter

public void addFooter(org.apache.tools.ant.taskdefs.Javadoc.Html footer)

Alternative setter method for this XdcTask's footer attribute.

Parameters:

footer - The footer (in HTML format) to be set

setBottom

public void setBottom(java.lang.String bottom)

Setter method for this XdcTask's bottom attribute.

Parameters:

bottom - The bottom attribute to be set

addBottom

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

Alternative setter method for this XdcTask's bottom attribute.

Parameters:

bottom - The bottom (in HTML format) to be set

setReportmissing

public void setReportmissing(boolean reportmissing)

Setter method for this XdcTask's reportmissing attribute.

Parameters:

reportmissing - The reportmissing attribute to be set

createArg

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

Getter method for a new argument to be passed to this XdcTask.

Returns:

A new argument for passing to this XdcTask.

createJvmarg

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

Getter method for a new Java VM argument to be passed to this XdcTask.

Returns:

A new Java VM argument for passing to this XdcTask.

setCharset

public void setCharset(java.lang.String charset)

Setter method for this XdcTask's charset attribute. This may be the name or the alias of any known character set.

Parameters:

charset - The charset name or alias to be set

setEncoding

public void setEncoding(java.lang.String encoding)

Setter method for this XdcTask's encoding attribute. This may be the name or the alias of any known character set.

Parameters:

encoding - The encoding name or alias to be set

setDocencoding

public void setDocencoding(java.lang.String docencoding)

Setter method for this XdcTask's docencoding attribute. This may be the name or the alias of any known character set.

Parameters:

docencoding - The docencoding name or alias to be set

setLocale

public void setLocale(java.lang.String locale)

Setter method for this XdcTask's locale attribute.

Parameters:

locale - The locale name to be set

execute

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

This method executes this XdcTask.

Throws:

org.apache.tools.ant.BuildException