org.apache.tools.ant.types

Class Environment.Variable

java.lang.Object

org.apache.tools.ant.types.Environment.Variable

Enclosing class:

Environment

public static class Environment.Variable
extends java.lang.Object

representation of a single env value

Constructor Summary

Constructors

Constructor and Description
Variable() Constructor for variable

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() get the assignment string This is not ready for insertion into a property file without following the escaping rules of the properties class.
java.lang.String	getKey() key accessor
java.lang.String	getValue() value accessor
void	setFile(java.io.File file) get the absolute path of a file and assign it to the value
void	setKey(java.lang.String key) set the key
void	setPath(Path path) stringify path and assign to the value.
void	setValue(java.lang.String value) set the value
void	validate() checks whether all required attributes have been specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

Variable

public Variable()

Constructor for variable

Method Detail

setKey

public void setKey(java.lang.String key)

set the key

Parameters:

key - string

setValue

public void setValue(java.lang.String value)

set the value

Parameters:

value - string value

getKey

public java.lang.String getKey()

key accessor

Returns:

key

getValue

public java.lang.String getValue()

value accessor

Returns:

value

setPath

public void setPath(Path path)

stringify path and assign to the value. The value will contain all path elements separated by the appropriate separator

Parameters:

path - path

setFile

public void setFile(java.io.File file)

get the absolute path of a file and assign it to the value

Parameters:

file - file to use as the value

getContent

public java.lang.String getContent()
                            throws BuildException

get the assignment string This is not ready for insertion into a property file without following the escaping rules of the properties class.

Returns:

a string of the form key=value.

Throws:

BuildException - if key or value are unassigned

validate

public void validate()

checks whether all required attributes have been specified.

Throws:

BuildException - if key or value are unassigned