org.wandora.modules

Interface ReplacementsModule

All Superinterfaces:

Module

All Known Implementing Classes:

DefaultReplacementsModule

public interface ReplacementsModule
extends Module

The interface for the replacements system. The replacements system is a simpler lighter weight option to proper templates. It can perform simple search and replace functions, with possibly dynamic replace values. For example, if you only need to add a name, or email address, or some other small simple thing, in an otherwise static string, you can use the replacements method instead of a full templating language. The only implementation at the moment is DefaultReplacementsModule, but other implementations could be added.

Author:

olli

Method Summary

Modifier and Type	Method and Description
java.lang.String	replaceValue(java.lang.String value, java.util.HashMap<java.lang.String,java.lang.Object> context) Replace the values in the given string using the given context.

Methods inherited from interface org.wandora.modules.Module

getDependencies, init, isInitialized, isRunning, start, stop

Method Detail

replaceValue

java.lang.String replaceValue(java.lang.String value,
                              java.util.HashMap<java.lang.String,java.lang.Object> context)

Replace the values in the given string using the given context. The exact way the context is used depends on the implementation. It is not necessarily used so that every occurrence of the key in the context is replaced with the value.

Parameters:

value - The string in which replacements are to be done.

context - A context used in the replacements.

Returns: