prantl.ant.eclipse
Class VariableElement

java.lang.Object
  prantl.ant.eclipse.VariableElement

public class VariableElement
extends java.lang.Object

Configures name and value of a variable in a preferences file under the directory .settings. Both attributes name and value are mandatory.

Since:

Ant-Eclipse 1.0

Author:

Ferdinand Prantl <prantl@users.sourceforge.net>

Constructor Summary

VariableElement(PreferencesElement parent)
Creates a new instance of the variable element.

Method Summary

java.lang.String	getName() Returns the name of the configuration variable.
java.lang.String	getValue() Returns the value of the configuration variable.
void	setName(java.lang.String name) Sets the name of the configuration variable.
void	setValue(java.lang.String value) Sets the value of the configuration variable.
void	validate() Performs the validation of the element at the time when the whole build file was parsed checking the content of the element and possibly adding mandatory variables with default settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableElement

public VariableElement(PreferencesElement parent)

Creates a new instance of the variable element.

Parameters:

parent - The parent preferences element of this variable one.

Since:

Ant-Eclipse 1.0

Method Detail

getName

public java.lang.String getName()

Returns the name of the configuration variable. The name must not be null, it is a mandatory attribute.

Returns:

The name of the configuration variable or null if having not been set.

getValue

public java.lang.String getValue()

Returns the value of the configuration variable. The value must not be null, it is a mandatory attribute.

Returns:

The value of the configuration variable or null if having not been set.

setName

public void setName(java.lang.String name)

Sets the name of the configuration variable.

Parameters:

name - A name of the configuration variable.

Since:

Ant-Eclipse 1.0

setValue

public void setValue(java.lang.String value)

Sets the value of the configuration variable.

Parameters:

value - A value of the configuration variable.

Since:

Ant-Eclipse 1.0

validate

public void validate()

Performs the validation of the element at the time when the whole build file was parsed checking the content of the element and possibly adding mandatory variables with default settings.

Since:

Ant-Eclipse 1.0