net.webpdf.ant.task.variable

Class Variable

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

net.webpdf.ant.task.Task

net.webpdf.ant.task.variable.Variable

All Implemented Interfaces:

Cloneable, TaskIntf

public class Variable
extends Task

Manages a task storing a variable property. This solution is entirely base on Ant-contrib Variable and an instance of this class is just a wrapper providing some convenience methods.

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

Constructors

Constructor and Description
Variable() An instance of this class manages and stores a variable property.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Attempts to publish the currently stored value for the given variable name.
String	getName() Returns the referable name of the variable.
VariableRole	getRole() Returns the role of the variable and provides information about it's usage and purpose via the VariableRole enum.
String	getValue() Returns the value of the variable.
void	setName(String name) Alters the referable name of the variable.
void	setOwningTask(Task owningTask) Change the task owning this variable.
void	setRole(VariableRole role) Alters the role of the variable and provides information about it's usage and purpose via the VariableRole enum.
void	setValue(String value) Alters the value of the variable.

Methods inherited from class net.webpdf.ant.task.Task

getFiles, getLogger, getTaskConfiguration, getVariables, setFiles, setTaskConfiguration

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

Variable

public Variable()

An instance of this class manages and stores a variable property.

Method Detail

setOwningTask

public void setOwningTask(Task owningTask)

Change the task owning this variable.

Parameters:

owningTask - The task that shall be owning the variable.

execute

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

Attempts to publish the currently stored value for the given variable name.

Specified by:

execute in interface TaskIntf

Specified by:

execute in class Task

Throws:

org.apache.tools.ant.BuildException - Shall be thrown, if an error occurred while publishing this variable.

setName

public void setName(String name)

Alters the referable name of the variable.

Parameters:

name - The referable name of the variable.

getName

public String getName()

Returns the referable name of the variable.

Returns:

The referable name of the variable.

setValue

public void setValue(String value)

Alters the value of the variable.

Parameters:

value - The value of the variable.

getValue

public String getValue()

Returns the value of the variable.

Returns:

The value of the variable.

setRole

public void setRole(VariableRole role)

Alters the role of the variable and provides information about it's usage and purpose via the VariableRole enum.

Parameters:

role - The role of this variable in it's context.

getRole

public VariableRole getRole()

Returns the role of the variable and provides information about it's usage and purpose via the VariableRole enum.

Returns:

The role of this variable in it's context.