org.apache.commons.launcher.types

Class ConditionalVariable

public class ConditionalVariable extends DataType

A class that represents nested or elements. This class provides the same functionality as the class that represents these same elements in a "java" task. In addition, this class supports conditional "if" and "unless" attributes.

Author: Patrick Luby

Method Summary
StringgetIf()
Get the "if" condition flag.
StringgetKey()
Get the key.
StringgetUnless()
Get the "unless" condition flag.
StringgetValue()
Get the value.
voidsetFile(File file)
Set the value to a File.
voidsetFile(Path path)
Set the value to a Path.
voidsetIf(String property)
Set the "if" condition.
voidsetKey(String key)
Set the key.
voidsetPath(Path path)
Set the value to a Path.
voidsetUnless(String property)
Set the "unless" condition.
voidsetValue(String value)
Set the value.

Method Detail

getIf

public String getIf()
Get the "if" condition flag.

Returns: the "if" condition flag

getKey

public String getKey()
Get the key.

Returns: the key for this variable

getUnless

public String getUnless()
Get the "unless" condition flag.

Returns: the "unless" condition flag

getValue

public String getValue()
Get the value.

Returns: the value for this variable

setFile

public void setFile(File file)
Set the value to a File.

Parameters: value the File for this variable

setFile

public void setFile(Path path)
Set the value to a Path.

Parameters: value the Path for this variable

setIf

public void setIf(String property)
Set the "if" condition. Tasks that nest this class as an element should evaluate this flag in their org.apache.tools.ant.Task#execute() method. If the following conditions are true, the task should process this element:

Parameters: property a property name or macro

setKey

public void setKey(String key)
Set the key.

Parameters: key the key for this variable

setPath

public void setPath(Path path)
Set the value to a Path.

Parameters: value the Path for this variable

setUnless

public void setUnless(String property)
Set the "unless" condition. Tasks that nest this class as an element should evaluate this flag in their org.apache.tools.ant.Task#execute() method. If the following conditions are true, the task should ignore this element:

Parameters: property a property name or macro

setValue

public void setValue(String value)
Set the value.

Parameters: value the value for this variable

Copyright (c) 2001-2002 - Apache Software Foundation