com.nobigsoftware.dfalex

Interface StringReplacement

public interface StringReplacement

Functional interface that provides the replacement values for strings in a search+replace operation of patterns found in a string.

Method Summary

Modifier and Type	Method and Description
int	apply(SafeAppendable dest, java.lang.CharSequence src, int startPos, int endPos) This will be called for each instance of each pattern found

Method Detail

apply

int apply(SafeAppendable dest,
          java.lang.CharSequence src,
          int startPos,
          int endPos)

This will be called for each instance of each pattern found

Parameters:

dest - The replacement text for the matching substring should be written here

src - The string being searched, or the part of the stream being searched that contains the current match

startPos - the start index of the current match in src

endPos - the end index of the current match in src

Returns:

if this is >0, then it is the position in the source string at which to continue processing after replacement. If you set this <= startPos, an IndexOutOfBoundsException will be thrown to abort the infinite loop that would result. Almost always return 0.