KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > oro > text > regex > StringSubstitution


1 package org.apache.oro.text.regex;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2000 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
29  * must not be used to endorse or promote products derived from this
30  * software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
35  * name, without prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  *
56  * Portions of this software are based upon software originally written
57  * by Daniel F. Savarese. We appreciate his contributions.
58  */
59
60 /**
61  * StringSubstitution implements a Substitution consisting of a simple
62  * literal string. This class is intended for use with
63  * {@link Util#substitute Util.substitute}.
64
65  @author <a HREF="dfs@savarese.org">Daniel F. Savarese</a>
66  @version $Id: StringSubstitution.java,v 1.1.1.1 2000/07/23 23:08:54 jon Exp $
67
68  * @see Substitution
69  * @see Util
70  * @see Util#substitute
71  * @see Substitution
72  * @see Perl5Substitution
73  */
74 public class StringSubstitution implements Substitution {
75   int _subLength;
76   String JavaDoc _substitution;
77
78   /**
79    * Default constructor initializing substitution to a zero length
80    * String.
81    */
82   public StringSubstitution() {
83     this("");
84   }
85
86   /**
87    * Creates a StringSubstitution representing the given string.
88    * <p>
89    * @param substitution The string to use as a substitution.
90    */
91   public StringSubstitution(String JavaDoc substitution) {
92     setSubstitution(substitution);
93   }
94
95
96   /**
97    * Sets the substitution represented by this StringSubstitution. You
98    * should use this method in order to avoid repeatedly allocating new
99    * StringSubstitutions. It is recommended that you allocate a single
100    * StringSubstitution and reuse it by using this method when appropriate.
101    * <p>
102    * @param substitution The string to use as a substitution.
103    */
104   public void setSubstitution(String JavaDoc substitution) {
105     _substitution = substitution;
106     _subLength = substitution.length();
107   }
108
109   /**
110    * Returns the string substitution represented by this object.
111    * <p>
112    * @return The string substitution represented by this object.
113    */
114   public String JavaDoc getSubstitution() { return _substitution; }
115
116   /**
117    * Returns the same value as {@link #getSubstitution()}.
118    * <p>
119    * @return The string substitution represented by this object.
120    */
121   public String JavaDoc toString() { return getSubstitution(); }
122
123   /**
124    * Appends the substitution to a buffer containing the original input
125    * with substitutions applied for the pattern matches found so far.
126    * See
127    * {@link Substitution#appendSubstitution Substitution.appendSubstition()}
128    * for more details regarding the expected behavior of this method.
129    * <p>
130    * @param appendBuffer The buffer containing the new string resulting
131    * from performing substitutions on the original input.
132    * @param match The current match causing a substitution to be made.
133    * @param substitutionCount The number of substitutions that have been
134    * performed so far by Util.substitute.
135    * @param originalInput The original input upon which the substitutions are
136    * being performed.
137    * @param matcher The PatternMatcher used to find the current match.
138    * @param pattern The Pattern used to find the current match.
139    */
140   public void appendSubstitution(StringBuffer JavaDoc appendBuffer, MatchResult match,
141                  int substitutionCount, String JavaDoc originalInput,
142                  PatternMatcher matcher, Pattern pattern)
143   {
144     if(_subLength == 0)
145       return;
146     appendBuffer.append(_substitution);
147   }
148 }
149
Popular Tags