org.oddjob.ant

Class OddjobTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.oddjob.ant.OddjobTask

All Implemented Interfaces:

java.lang.Cloneable

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

This is an ant task which runs Oddjob.

This is an example of using it in a build file.

 <taskdef name="oddjob" 
             classname="org.oddjob.ant.OddjobTask"/>

 <target name="simple"
        description="Run somehting simple"/>
   <oddjob config="simple/oddjob.xml"/>
 </target>

Author:

Rob Gordon

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ODDJOB_HOME_PROPERTY

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

Constructors

Constructor and Description
OddjobTask()

Method Summary

Modifier and Type	Method and Description
org.apache.tools.ant.taskdefs.Property	createProperty() Property to pass to the new project.
void	execute() Execute the job.
java.lang.String	getArgs()
java.io.File	getFile()
java.lang.String	getName() Get the name.
java.io.File	getOddballsDir()
java.lang.String	getOddballsPath()
boolean	isInheritAll()
boolean	isNoOddballs()
void	setArgs(java.lang.String args)
void	setFile(java.io.File file)
void	setInheritAll(boolean inheritAll)
void	setName(java.lang.String name) Set the name.
void	setNoOddballs(boolean noOddballs)
void	setOddballsDir(java.io.File oddballsDir)
void	setOddballsPath(java.lang.String oddballsPath)

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

ODDJOB_HOME_PROPERTY

public static final java.lang.String ODDJOB_HOME_PROPERTY

See Also:

Constant Field Values

Constructor Detail

OddjobTask

public OddjobTask()

Method Detail

execute

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

Execute the job.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException

setName

public void setName(java.lang.String name)

Set the name.

Parameters:

name - The name.

getName

public java.lang.String getName()

Get the name.

Returns:

The name.

isInheritAll

public boolean isInheritAll()

setInheritAll

public void setInheritAll(boolean inheritAll)

createProperty

public org.apache.tools.ant.taskdefs.Property createProperty()

Property to pass to the new project. The property is passed as a 'user property'.

Returns:

the created Property object.

getFile

public java.io.File getFile()

setFile

public void setFile(java.io.File file)

getOddballsDir

public java.io.File getOddballsDir()

setOddballsDir

public void setOddballsDir(java.io.File oddballsDir)

isNoOddballs

public boolean isNoOddballs()

setNoOddballs

public void setNoOddballs(boolean noOddballs)

getOddballsPath

public java.lang.String getOddballsPath()

setOddballsPath

public void setOddballsPath(java.lang.String oddballsPath)

getArgs

public java.lang.String getArgs()

setArgs

public void setArgs(java.lang.String args)