01: /*
02: * This file is part of "SnipSnap Radeox Rendering Engine".
03: *
04: * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
05: * All Rights Reserved.
06: *
07: * Please visit http://radeox.org/ for updates and contact.
08: *
09: * --LICENSE NOTICE--
10: * Licensed under the Apache License, Version 2.0 (the "License");
11: * you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software
17: * distributed under the License is distributed on an "AS IS" BASIS,
18: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19: * See the License for the specific language governing permissions and
20: * limitations under the License.
21: * --LICENSE NOTICE--
22: */
23:
24: package org.radeox.regex;
25:
26: /*
27: * Called with a MatchResult which is substituted @author stephan @team
28: * sonicteam
29: *
30: * @version $Id: Substitution.java 7756 2006-04-13 12:25:49Z ian@caret.cam.ac.uk $
31: */
32:
33: public interface Substitution {
34: /**
35: * When substituting matches in a matcher, the handleMatch method of the
36: * supplied substitution is called with a MatchResult. This method then does
37: * something with the match and replaces the match with some output, like
38: * replace all 2*2 with (2*2 =) 4.
39: *
40: * @param buffer
41: * StringBuffer to append the output to
42: * @param result
43: * MatchResult with the match
44: */
45: public void handleMatch(StringBuffer buffer, MatchResult result);
46: }
|