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
 Object getVariable(String name, cookxml.core.DecodeEngine decodeEngine)
          Get a variable by its name.
 void setVariable(String name, Object value, cookxml.core.DecodeEngine decodeEngine)
          Set a variable by its name.
 

Method Detail

getVariable

Object getVariable(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(String name,
                 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.