org.apache.cocoon
Class CocoonTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.cocoon.CocoonTask

All Implemented Interfaces:

Cloneable, org.apache.tools.ant.DynamicAttribute, org.apache.tools.ant.DynamicConfigurator, org.apache.tools.ant.DynamicElement

public class CocoonTask
extends org.apache.tools.ant.Task
implements org.apache.tools.ant.DynamicConfigurator

Ant task for running Cocoon. Allows for the embedding of Cocoon into

Version:

CVS $Id: CocoonTask.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Upayavira

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

CocoonTask()

Method Summary

org.apache.tools.ant.types.Path	createClasspath() Adds a path to the classpath.
Object	createDynamicElement(String name)
void	execute() Do the execution and return a return code.
void	execute(org.apache.tools.ant.types.CommandlineJava command)
File	getLibDir()
void	run(Method method)
void	setClasspath(org.apache.tools.ant.types.Path s) Set the classpath to be used when running the Java class
void	setClasspathRef(org.apache.tools.ant.types.Reference r) Classpath to use, by reference.
void	setDynamicAttribute(String name, String value)
void	setUrigroup(String group)

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

CocoonTask

public CocoonTask()

Method Detail

createClasspath

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

Adds a path to the classpath.

Returns:

created classpath

setClasspathRef

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

Classpath to use, by reference.

Parameters:

r - a reference to an existing classpath

setClasspath

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

Set the classpath to be used when running the Java class

Parameters:

s - an Ant Path object containing the classpath.

setUrigroup

public void setUrigroup(String group)

getLibDir

public File getLibDir()
               throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

setDynamicAttribute

public void setDynamicAttribute(String name,
                                String value)
                         throws org.apache.tools.ant.BuildException

Specified by:

setDynamicAttribute in interface org.apache.tools.ant.DynamicAttribute

Throws:

org.apache.tools.ant.BuildException

createDynamicElement

public Object createDynamicElement(String name)
                            throws org.apache.tools.ant.BuildException

Specified by:

createDynamicElement in interface org.apache.tools.ant.DynamicElement

Throws:

org.apache.tools.ant.BuildException

execute

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

Do the execution and return a return code.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException - if required parameters are missing

execute

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

Throws:

org.apache.tools.ant.BuildException

run

public void run(Method method)