org.pfsw.text

Class AbstractPlaceholderReplacer

java.lang.Object

org.pfsw.text.AbstractPlaceholderReplacer

All Implemented Interfaces:

IFunction<java.lang.String,java.lang.String>, PlaceholderReplacer

Direct Known Subclasses:

DefaultPlaceholderReplacer

public abstract class AbstractPlaceholderReplacer
extends java.lang.Object
implements PlaceholderReplacer

Abstract standard implementation for replacing multiple placeholders identified by a start and end delimiter in a string. Placeholders that cannot be resolved will be left unchanged in the result string.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPlaceholderReplacer(java.lang.String startDelimiter, java.lang.String endDelimiter)

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.lang.String string) Applies this function to the given argument.
protected java.lang.String	detectAndReplacePlaceholders(java.lang.String input)
protected java.lang.String	getDefaultSeparator()
java.lang.String	getEndDelimiter()
java.lang.String	getStartDelimiter()
protected abstract java.lang.String	getValueOfPlaceholder(java.lang.String placeholderName, java.lang.String defaultValue)
java.lang.String	replacePlaceholders(java.lang.String input) Replaces all placeholders in the given input string and returns the new string where the placeholders have been replaced.
protected IStringPair	separateNameAndDefaultValue(java.lang.String placeholderName)
protected StringUtil	str()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

AbstractPlaceholderReplacer

protected AbstractPlaceholderReplacer(java.lang.String startDelimiter,
                                      java.lang.String endDelimiter)

Method Detail

apply

public java.lang.String apply(java.lang.String string)

Description copied from interface: IFunction

Applies this function to the given argument.

Specified by:

apply in interface IFunction<java.lang.String,java.lang.String>

Parameters:

string - the function argument

Returns:

the function result

replacePlaceholders

public java.lang.String replacePlaceholders(java.lang.String input)

Description copied from interface: PlaceholderReplacer

Replaces all placeholders in the given input string and returns the new string where the placeholders have been replaced.

The placeholder syntax and where the replacement values are coming from is specific to the implementation.

Specified by:

replacePlaceholders in interface PlaceholderReplacer

Parameters:

input - The string that contains placeholders (might be null).

Returns:

The new string with all placeholders that could be replaced, have been replaced or null if the input was null.

getStartDelimiter

public java.lang.String getStartDelimiter()

getEndDelimiter

public java.lang.String getEndDelimiter()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

detectAndReplacePlaceholders

protected java.lang.String detectAndReplacePlaceholders(java.lang.String input)

separateNameAndDefaultValue

protected IStringPair separateNameAndDefaultValue(java.lang.String placeholderName)

getDefaultSeparator

protected java.lang.String getDefaultSeparator()

getValueOfPlaceholder

protected abstract java.lang.String getValueOfPlaceholder(java.lang.String placeholderName,
                                                          java.lang.String defaultValue)

str

protected StringUtil str()