cookxml.core.interfaces

Interface VarLookup

public interface VarLookup

This is a general interface for getting/setting object variables

Since:

CookXml 2.0

Version:

$Id: VarLookup.java 218 2007-06-06 06:10:10Z coconut $

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getVariable(java.lang.String name, cookxml.core.DecodeEngine decodeEngine) Get a variable by its name.
void	setVariable(java.lang.String name, java.lang.Object value, cookxml.core.DecodeEngine decodeEngine) Set a variable by its name.

Method Detail

getVariable

java.lang.Object getVariable(java.lang.String name,
                             cookxml.core.DecodeEngine decodeEngine)
                      throws VarLookupException

Get a variable by its name.

Parameters:

name - the name of the variable

decodeEngine - the DecodeEngine being used.

Returns:

the value of the variable.

Throws:

VarLookupException - in case of error.

setVariable

void setVariable(java.lang.String name,
                 java.lang.Object value,
                 cookxml.core.DecodeEngine decodeEngine)
          throws VarLookupException

Set a variable by its name.

Parameters:

name - the name of the variable

value - the new value for the variable

decodeEngine - the DecodeEngine being used.

Throws:

VarLookupException - in case of error.