org.apache.commons.jxpath.servlet

Class KeywordVariables

java.lang.Object

org.apache.commons.jxpath.servlet.KeywordVariables

All Implemented Interfaces:

java.io.Serializable, Variables

public class KeywordVariables
extends java.lang.Object
implements Variables

Implementation of the Variables interface that provides access to a single object using a reserved name (keyword).

Version:

$Revision: 652925 $ $Date: 2008-05-02 17:05:41 -0500 (Fri, 02 May 2008) $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	keyword
private java.lang.Object	object
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
KeywordVariables(java.lang.String keyword, java.lang.Object object) Create a new KeywordVariables.

Method Summary

Modifier and Type	Method and Description
void	declareVariable(java.lang.String variable, java.lang.Object value) Defines a new variable with the specified value or modifies the value of an existing variable.
java.lang.Object	getVariable(java.lang.String variable) Returns the value of the specified variable.
boolean	isDeclaredVariable(java.lang.String variable) Returns true if the specified variable is declared.
void	undeclareVariable(java.lang.String variable) Removes an existing variable.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

keyword

private java.lang.String keyword

object

private java.lang.Object object

Constructor Detail

KeywordVariables

public KeywordVariables(java.lang.String keyword,
                        java.lang.Object object)

Create a new KeywordVariables.

Parameters:

keyword - String

object - value

Method Detail

isDeclaredVariable

public boolean isDeclaredVariable(java.lang.String variable)

Description copied from interface: Variables

Returns true if the specified variable is declared.

Specified by:

isDeclaredVariable in interface Variables

Parameters:

variable - variable name

Returns:

boolean

getVariable

public java.lang.Object getVariable(java.lang.String variable)

Description copied from interface: Variables

Returns the value of the specified variable.

Specified by:

getVariable in interface Variables

Parameters:

variable - variable name

Returns:

Object value

declareVariable

public void declareVariable(java.lang.String variable,
                            java.lang.Object value)

Description copied from interface: Variables

Defines a new variable with the specified value or modifies the value of an existing variable. May throw UnsupportedOperationException.

Specified by:

declareVariable in interface Variables

Parameters:

variable - variable name

value - to declare

undeclareVariable

public void undeclareVariable(java.lang.String variable)

Description copied from interface: Variables

Removes an existing variable. May throw UnsupportedOperationException.

Specified by:

undeclareVariable in interface Variables

Parameters:

variable - is a variable name without the "$" sign