org.xmlactions.common.text

Class ReplaceMarkers

java.lang.Object

org.xmlactions.common.text.ReplaceMarkers

public class ReplaceMarkers
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReplaceMarkers()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	removeUnusedMarkers(java.lang.String text, java.lang.Object missingReplacementValue) This will remove unset markers within the text.
static java.lang.String	replace(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> map) This will firstly replace any markers within the text with values found in the map and secondly remove any unset markers within the text.
static java.lang.String	replace(java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> map, java.lang.Object missingReplacementValue) This will firstly replace any markers within the text with values found in the map and secondly remove any unset markers within the text.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceMarkers

public ReplaceMarkers()

Method Detail

replace

public static java.lang.String replace(java.lang.String text,
                                       java.util.Map<java.lang.String,java.lang.Object> map)

This will firstly replace any markers within the text with values found in the map and secondly remove any unset markers within the text. An unset marker is ${...}. This usually means that the StrSubstutior was not able to find a value for the marker and so left it unchanged. Any unset markers will be replaced with "null"

Parameters:

text -

Returns:

the text updated with the replacement markers

replace

public static java.lang.String replace(java.lang.String text,
                                       java.util.Map<java.lang.String,java.lang.Object> map,
                                       java.lang.Object missingReplacementValue)

This will firstly replace any markers within the text with values found in the map and secondly remove any unset markers within the text. An unset marker is ${...}. This usually means that the StrSubstutior was not able to find a value for the marker and so left it unchanged. Any unset markers will be replaced with the missingReplaceValue.

Parameters:

text -

Returns:

the text updated with the replacement markers

removeUnusedMarkers

public static java.lang.String removeUnusedMarkers(java.lang.String text,
                                                   java.lang.Object missingReplacementValue)

This will remove unset markers within the text. An unset marker is ${...}. This usually means that the StrSubstutior was not able to find a value for the marker and so left it unchanged. This method will simply replace any ${...} that it finds in the text with a null.

Parameters:

text -

Returns:

the text with the replacement markers removed.