All Packages Class Hierarchy This Package Previous Next Index
Copyright © 1997-1998 Original Reusable Objects, Inc. All rights reserved.
public abstract void appendSubstitution(StringBuffer appendBuffer,
MatchResult match,
int substitutionCount,
String originalInput,
PatternMatcher matcher,
Pattern pattern)
For performance reasons, rather than provide a getSubstition method that returns a String used by Util.substitute, we have opted to pass a StringBuffer argument from Util.substitute to which the Substitution must append data. The contract that an appendSubstitution implementation must abide by is that the appendBuffer may only be appended to. appendSubstitution() may not alter the appendBuffer in any way other than appending to it.
This method is invoked by Util.substitute every time it finds a match. After finding a match, the Util.substitute appends to the appendBuffer all of the original input occuring between the end of the last match and the beginning of the current match. Then it invokes appendSubstitution(), passing the appendBuffer, current match, and other information as arguments. The substitutionCount keeps track of how many substitutions have been performed so far by an invocation of Util.substitute. Its value starts at 1 when the first substitution is found and appendSubstitution is invoked for the first time. It will NEVER be zero or a negative value.
All Packages Class Hierarchy This Package Previous Next Index