org.eclipse.scada.utils.str

Class StringReplacer

java.lang.Object

org.eclipse.scada.utils.str.StringReplacer

public class StringReplacer
extends Object

A helper class for replacing strings in strings

The default is to replace ${var} with var from a Map instance. But there are other ways possible by using different Pattern and StringReplacer.ReplaceSource implementations.

In order to replace a string with the ${var} pattern using Java System Properties use:

 String str = StringReplacer.replace ( "Hello ${user.name}!", System.getProperties () );
 

Replacing a variables in a string with bean like references use:

 class User
 {
     private String name;
 
     public String getName ()
     {
         return name;
     };
 
     User ( String name )
     {
         this.name = name;
     }
 }
 
 Map<String, User> userMap = Collections.singletonMap ( "user", new User ( "Arthur Dent" ) );
 
 String str = StringReplacer.replace ( "Hello ${user.name}!", userMap );
 

Author:

Jens Reimann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringReplacer.ReplaceSource

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	DEFAULT_PATTERN The default pattern: ${var}

Constructor Summary

Constructors

Constructor and Description
StringReplacer()

Method Summary

Modifier and Type	Method and Description
static StringReplacer.ReplaceSource	newBeansSource(Map<?,?> properties) Create a new ReplaceSource that handles bean references
static StringReplacer.ReplaceSource	newExtendedSource(Map<?,?> properties) Create a new ReplaceSource for Map sources which allows additional operators.
static StringReplacer.ReplaceSource	newSource(Map<?,?> properties) Create a new ReplaceSource for Map sources
static String	replace(String string, Map<?,?> properties) Replace with the default pattern of ${var}
static String	replace(String string, StringReplacer.ReplaceSource replaceSource, Pattern pattern) Replace variables in a string Actually calls replace ( string, replcaeSource, pattern, true ).
static String	replace(String string, StringReplacer.ReplaceSource replaceSource, Pattern pattern, boolean nested) Replace variables in a string

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PATTERN

public static final Pattern DEFAULT_PATTERN

The default pattern: ${var}

Constructor Detail

StringReplacer

public StringReplacer()

Method Detail

replace

public static String replace(String string,
                             Map<?,?> properties)

Replace with the default pattern of ${var}

Parameters:

string - the string which should be processed, may be null

properties - the properties used for replacing

Returns:

the source string with patterns replaced

newSource

public static StringReplacer.ReplaceSource newSource(Map<?,?> properties)

Create a new ReplaceSource for Map sources

The source will not replace elements that are not found in the map.

Parameters:

properties - the Map acting as a source

Returns:

the new replace source based on the Map

newExtendedSource

public static StringReplacer.ReplaceSource newExtendedSource(Map<?,?> properties)

Create a new ReplaceSource for Map sources which allows additional operators.

Parameters:

properties - the Map acting as a source

Returns:

the new replace source based on the Map

See Also:

ExtendedPropertiesReplacer

newBeansSource

public static StringReplacer.ReplaceSource newBeansSource(Map<?,?> properties)

Create a new ReplaceSource that handles bean references

Parameters:

properties - the properties to use for replacing

Returns:

the new ReplaceSource instance

replace

public static String replace(String string,
                             StringReplacer.ReplaceSource replaceSource,
                             Pattern pattern,
                             boolean nested)

Replace variables in a string

Parameters:

string - the string to process

replaceSource - the source of the replacements

pattern - the pattern for detecting variables

nested - true if the replacement process should honor nested replacements

Returns:

the replaced string, or null if the input string was null

replace

public static String replace(String string,
                             StringReplacer.ReplaceSource replaceSource,
                             Pattern pattern)

Replace variables in a string
Actually calls replace ( string, replcaeSource, pattern, true ).