net.webpdf.ant.task.variable

Class VariableMap

java.lang.Object

net.webpdf.ant.task.variable.VariableMap

public class VariableMap
extends Object

Stores variables for a task and allows to retrieve said variables using their role.

Constructor Summary

Constructors

Constructor and Description
VariableMap(Task task) Creates a fresh variable container for the given task.F

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Variable variable) Add the given variable to this variable container.
Variable	getVar(VariableRole role) Returns the variable, that is currently serving the given role.
boolean	isRoleTaken(VariableRole role) Returns true if a variable has already been assigned to the given role.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableMap

public VariableMap(Task task)

Creates a fresh variable container for the given task.F

Parameters:

task - The task a variable container shall be created for.

Method Detail

getVar

public Variable getVar(VariableRole role)

Returns the variable, that is currently serving the given role. Or null, if such a variable can not be found.

Parameters:

role - The role the searched variable shall have.

Returns:

The variable, that serves the given purpose, or null, if such a variable can not be found.

add

public void add(Variable variable)

Add the given variable to this variable container.

Parameters:

variable - The variable, that shall be added to the task container.

isRoleTaken

public boolean isRoleTaken(VariableRole role)

Returns true if a variable has already been assigned to the given role.

Parameters:

role - The role, that shall be checked.

Returns:

Returns true if a variable has been assigned to the given role.