org.jcoderz.commons.taskdefs
Class XtremeDocs

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.jcoderz.commons.taskdefs.XtremeDocs

All Implemented Interfaces:

Cloneable

public class XtremeDocs
extends org.apache.tools.ant.Task

Xtreme Documentation Ant task.

Author:

Michael Griffel

Nested Class Summary

static class	XtremeDocs.FormatterInfoData The Class FormatterInfoData.
static class	XtremeDocs.HibernateInfoData The Class HibernateInfoData.

Field Summary

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

XtremeDocs()

Method Summary

void	addParam(org.apache.tools.ant.types.Environment.Variable var) Add the given property to be sent to the transformer.
void	addSrc(SourceDirectory src) Set the source path to be used for this task run.
org.apache.tools.ant.types.Path	createClasspath() The classpath that is used to find the classes for the DocBook formatters.
org.apache.tools.ant.types.Path	createDocletpath() Additional path that is used to find the javadoc doclets.
XtremeDocs.FormatterInfoData	createFormatter() Creates a new FormatterInfoData object used as nested element to describe the DocBook formatters.
XtremeDocs.HibernateInfoData	createHibernate() Creates a new HibernateInfoData object used as nested element to describe the Hibernate Generator options.
void	execute() Execute this task.
boolean	failOnError() Returns true if this task (or subtasks) should fail on any error; false otherwise.
org.apache.tools.ant.types.Path	getClassPath() Returns the classpath element.
void	setCclabel(String label) Set the document type.
void	setCompanyLogo(String companyLogo) Set the name of the company logo without suffix.
void	setCompanyName(String companyName) Set the name of the company or organisation.
void	setFailonerror(boolean b) Set whether we should fail on an error.
void	setFormat(String format) Set the document format.
void	setIn(File f) Sets the XML input file that contains the document.
void	setOut(File dir) Set the destination directory into which the result files should be copied to.
void	setType(String type) Set the document type.
void	setValidationOnly(boolean validationOnly) Set the flag, whether only validation should be executed or not.
void	setXephome(File dir) Set the XEP home directory.

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

Constructor Detail

XtremeDocs

public XtremeDocs()

Method Detail

addParam

public void addParam(org.apache.tools.ant.types.Environment.Variable var)

Add the given property to be sent to the transformer.

Parameters:

var - the property to be sent to the transformer.

setIn

public void setIn(File f)

Sets the XML input file that contains the document.

Parameters:

f - the XML input file (log message info).

setOut

public void setOut(File dir)

Set the destination directory into which the result files should be copied to. This parameter is required.

Parameters:

dir - the name of the destination directory.

setXephome

public void setXephome(File dir)

Set the XEP home directory.

Parameters:

dir - the name of the XEP home directory.

setType

public void setType(String type)

Set the document type.

Parameters:

type - the document type.

setFormat

public void setFormat(String format)

Set the document format.

Parameters:

format - the document format.

setCclabel

public void setCclabel(String label)

Set the document type.

Parameters:

label - the cruise control label.

setCompanyName

public void setCompanyName(String companyName)

Set the name of the company or organisation.

Parameters:

companyName - The mCompanyName to set.

setValidationOnly

public void setValidationOnly(boolean validationOnly)

Set the flag, whether only validation should be executed or not.

Parameters:

validationOnly - The mValidationOnly to set.

setCompanyLogo

public void setCompanyLogo(String companyLogo)

Set the name of the company logo without suffix.

Parameters:

companyLogo - The mCompanyLogo to set.

setFailonerror

public void setFailonerror(boolean b)

Set whether we should fail on an error.

Parameters:

b - Whether we should fail on an error.

createDocletpath

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

Additional path that is used to find the javadoc doclets.

Returns:

a path.

createClasspath

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

The classpath that is used to find the classes for the DocBook formatters.

Returns:

a path.

createFormatter

public XtremeDocs.FormatterInfoData createFormatter()

Creates a new FormatterInfoData object used as nested element to describe the DocBook formatters.

Returns:

a new FormatterInfoData object.

createHibernate

public XtremeDocs.HibernateInfoData createHibernate()

Creates a new HibernateInfoData object used as nested element to describe the Hibernate Generator options.

Returns:

a new FormatterInfoData object.

getClassPath

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

Returns the classpath element.

Returns:

the classpath element.

failOnError

public boolean failOnError()

Returns true if this task (or subtasks) should fail on any error; false otherwise.

Returns:

true if this task (or subtasks) should fail on any error; false otherwise.

addSrc

public void addSrc(SourceDirectory src)

Set the source path to be used for this task run.

Parameters:

src - an Ant FileSet object containing the compilation source path.

execute

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

Execute this task.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException - An building exception occurred.