org.openbase.jul.processing

Interface VariableProvider

All Known Implementing Classes:

VariableStore

public interface VariableProvider

* @author Divine Divine Threepwood

Field Summary

Fields

Modifier and Type	Field and Description
static String	VARIABLE_INITIATOR
static String	VARIABLE_TERMINATOR

Method Summary

Modifier and Type	Method and Description
String	getName() Method return the name of this provider.
String	getValue(String variable)
Map<String,String>	getValues(String variableContains) Method resolves all variables whose name contains the given identifier.

Field Detail

VARIABLE_INITIATOR

static final String VARIABLE_INITIATOR

See Also:

Constant Field Values

VARIABLE_TERMINATOR

static final String VARIABLE_TERMINATOR

See Also:

Constant Field Values

Method Detail

getName

String getName()

Method return the name of this provider. The name should inform about the origin.

Returns:

the name as string.

getValue

String getValue(String variable)
         throws org.openbase.jul.exception.NotAvailableException

Parameters:

variable - the variable name to be resolved.

Returns:

the value of the variable.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the variable could not be resolved.

getValues

Map<String,String> getValues(String variableContains)
                      throws org.openbase.jul.exception.NotAvailableException

Method resolves all variables whose name contains the given identifier.

Parameters:

variableContains - the identifier to select the variables.

Returns:

a map of the variable name and its current value.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case no variable name matches the given identifier.