001: /*
002: * $Id: StringSubstitution.java,v 1.8 2003/11/07 20:16:25 dfs Exp $
003: *
004: * ====================================================================
005: * The Apache Software License, Version 1.1
006: *
007: * Copyright (c) 2000 The Apache Software Foundation. All rights
008: * reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions
012: * are met:
013: *
014: * 1. Redistributions of source code must retain the above copyright
015: * notice, this list of conditions and the following disclaimer.
016: *
017: * 2. Redistributions in binary form must reproduce the above copyright
018: * notice, this list of conditions and the following disclaimer in
019: * the documentation and/or other materials provided with the
020: * distribution.
021: *
022: * 3. The end-user documentation included with the redistribution,
023: * if any, must include the following acknowledgment:
024: * "This product includes software developed by the
025: * Apache Software Foundation (http://www.apache.org/)."
026: * Alternately, this acknowledgment may appear in the software itself,
027: * if and wherever such third-party acknowledgments normally appear.
028: *
029: * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
030: * must not be used to endorse or promote products derived from this
031: * software without prior written permission. For written
032: * permission, please contact apache@apache.org.
033: *
034: * 5. Products derived from this software may not be called "Apache"
035: * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
036: * name, without prior written permission of the Apache Software Foundation.
037: *
038: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
039: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
040: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
041: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
042: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
043: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
044: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
045: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
046: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
047: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
048: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
049: * SUCH DAMAGE.
050: * ====================================================================
051: *
052: * This software consists of voluntary contributions made by many
053: * individuals on behalf of the Apache Software Foundation. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.oro.text.regex;
059:
060: /**
061: * StringSubstitution implements a Substitution consisting of a simple
062: * literal string. This class is intended for use with
063: * {@link Util#substitute Util.substitute}.
064: *
065: * @version @version@
066: * @since 1.1
067: * @see Substitution
068: * @see Util
069: * @see Util#substitute
070: * @see Substitution
071: * @see Perl5Substitution
072: */
073: public class StringSubstitution implements Substitution {
074: int _subLength;
075: String _substitution;
076:
077: /**
078: * Default constructor initializing substitution to a zero length
079: * String.
080: */
081: public StringSubstitution() {
082: this ("");
083: }
084:
085: /**
086: * Creates a StringSubstitution representing the given string.
087: * <p>
088: * @param substitution The string to use as a substitution.
089: */
090: public StringSubstitution(String substitution) {
091: setSubstitution(substitution);
092: }
093:
094: /**
095: * Sets the substitution represented by this StringSubstitution. You
096: * should use this method in order to avoid repeatedly allocating new
097: * StringSubstitutions. It is recommended that you allocate a single
098: * StringSubstitution and reuse it by using this method when appropriate.
099: * <p>
100: * @param substitution The string to use as a substitution.
101: */
102: public void setSubstitution(String substitution) {
103: _substitution = substitution;
104: _subLength = substitution.length();
105: }
106:
107: /**
108: * Returns the string substitution represented by this object.
109: * <p>
110: * @return The string substitution represented by this object.
111: */
112: public String getSubstitution() {
113: return _substitution;
114: }
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 toString() {
122: return getSubstitution();
123: }
124:
125: /**
126: * Appends the substitution to a buffer containing the original input
127: * with substitutions applied for the pattern matches found so far.
128: * See
129: * {@link Substitution#appendSubstitution Substitution.appendSubstition()}
130: * for more details regarding the expected behavior of this method.
131: * <p>
132: * @param appendBuffer The buffer containing the new string resulting
133: * from performing substitutions on the original input.
134: * @param match The current match causing a substitution to be made.
135: * @param substitutionCount The number of substitutions that have been
136: * performed so far by Util.substitute.
137: * @param originalInput The original input upon which the substitutions are
138: * being performed. This is a read-only parameter and is not modified.
139: * @param matcher The PatternMatcher used to find the current match.
140: * @param pattern The Pattern used to find the current match.
141: */
142: public void appendSubstitution(StringBuffer appendBuffer,
143: MatchResult match, int substitutionCount,
144: PatternMatcherInput originalInput, PatternMatcher matcher,
145: Pattern pattern) {
146: if (_subLength == 0)
147: return;
148: appendBuffer.append(_substitution);
149: }
150: }
|