regexodus

Class Replacer

java.lang.Object

regexodus.Replacer

All Implemented Interfaces:

Serializable

public class Replacer
extends Object
implements Serializable

The Replacer class suggests some methods to replace occurrences of a pattern either by a result of evaluation of a perl-like expression, or by a plain string, or according to a custom substitution model, provided as a Substitution interface implementation.
A Replacer instance may be obtained either using Pattern.replacer(...) method, or by constructor:

 Pattern p=new Pattern("\\w+");
 Replacer perlExpressionReplacer=p.replacer("[$&]");
 //or another way to do the same
 Substitution myOwnModel=new Substitution(){
    public void appendSubstitution(MatchResult match,TextBuffer tb){
       tb.append('[');
       match.getGroup(MatchResult.MATCH,tb);
       tb.append(']');
    }
 }
 Replacer myVeryOwnReplacer=new Replacer(p,myOwnModel);
 

The second method is much more verbose, but gives more freedom. To perform a replacement call replace(someInput):

 System.out.print(perlExpressionReplacer.replace("All your base "));
 System.out.println(myVeryOwnReplacer.replace("are belong to us"));
 //result: "[All] [your] [base] [are] [belong] [to] [us]"
 

This code was mostly written in 2001, I hope the reference isn't too outdated...

See Also:

Substitution, PerlSubstitution, Replacer(regexodus.Pattern, regexodus.Substitution), Serialized Form

Constructor Summary

Constructors

Constructor and Description
Replacer(Pattern pattern, String substitution) Constructs a Replacer from a Pattern and a String to replace occurrences of the Pattern with.
Replacer(Pattern pattern, String substitution, boolean isPerlExpr)
Replacer(Pattern pattern, Substitution substitution) Unlikely to be used directly.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
String	replace(char[] chars, int off, int len)
int	replace(char[] chars, int off, int len, StringBuilder sb)
void	replace(char[] chars, int off, int len, Writer out)
String	replace(CharSequence text) Takes all instances in text of the Pattern this was constructed with, and replaces them with substitution.
int	replace(CharSequence text, StringBuilder sb) Takes all occurrences of the pattern this was constructed with in text and replaces them with the substitution.
int	replace(CharSequence text, TextBuffer dest)
void	replace(CharSequence text, Writer out)
static int	replace(Matcher m, Substitution substitution, TextBuffer dest) Replaces all occurrences of a matcher's pattern in a matcher's target by a given substitution appending the result to a buffer. The substitution starts from current matcher's position, current match not included.
static int	replace(Matcher m, Substitution substitution, TextBuffer dest, int count) Replaces the first n occurrences of a matcher's pattern, where n is equal to count, in a matcher's target by a given substitution, appending the result to a buffer.
String	replace(MatchResult res, int group)
int	replace(MatchResult res, int group, StringBuilder sb)
void	replace(MatchResult res, int group, Writer out)
int	replace(MatchResult res, String groupName, StringBuilder sb)
void	replace(MatchResult res, String groupName, Writer out)
String	replace(Reader text, int length)
int	replace(Reader text, int length, StringBuilder sb)
void	replace(Reader in, int length, Writer out)
void	setSubstitution(String s, boolean isPerlExpr)
String	toString()
static TextBuffer	wrap(StringBuilder sb)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Replacer

public Replacer(Pattern pattern,
                Substitution substitution)

Unlikely to be used directly.

Parameters:

pattern - a regexodus.Pattern that determines what should be replaced

substitution - an implementation of the Substitution interface, which allows custom replacement behavior

Replacer

public Replacer(Pattern pattern,
                String substitution)

Constructs a Replacer from a Pattern and a String to replace occurrences of the Pattern with.

Parameters:

pattern - a regexodus.Pattern that determines what should be replaced

substitution - a String that will be used to replace occurrences of the Pattern

Replacer

public Replacer(Pattern pattern,
                String substitution,
                boolean isPerlExpr)

Method Detail

setSubstitution

public void setSubstitution(String s,
                            boolean isPerlExpr)

replace

public String replace(CharSequence text)

Takes all instances in text of the Pattern this was constructed with, and replaces them with substitution.

Parameters:

text - a String, StringBuilder, or other CharSequence that may contain the text to replace

Returns:

the post-replacement text

replace

public String replace(char[] chars,
                      int off,
                      int len)

replace

public String replace(MatchResult res,
                      int group)

replace

public String replace(Reader text,
                      int length)
               throws IOException

Throws:

IOException

replace

public int replace(CharSequence text,
                   StringBuilder sb)

Takes all occurrences of the pattern this was constructed with in text and replaces them with the substitution. Appends the replaced text into sb.

Parameters:

text - a String, StringBuilder, or other CharSequence that may contain the text to replace

sb - the StringBuilder to append the result into

Returns:

the number of individual replacements performed; the results are applied to sb

replace

public int replace(char[] chars,
                   int off,
                   int len,
                   StringBuilder sb)

replace

public int replace(MatchResult res,
                   int group,
                   StringBuilder sb)

replace

public int replace(MatchResult res,
                   String groupName,
                   StringBuilder sb)

replace

public int replace(Reader text,
                   int length,
                   StringBuilder sb)
            throws IOException

Throws:

IOException

replace

public int replace(CharSequence text,
                   TextBuffer dest)

replace

public static int replace(Matcher m,
                          Substitution substitution,
                          TextBuffer dest)

Replaces all occurrences of a matcher's pattern in a matcher's target by a given substitution appending the result to a buffer.
The substitution starts from current matcher's position, current match not included.

replace

public static int replace(Matcher m,
                          Substitution substitution,
                          TextBuffer dest,
                          int count)

Replaces the first n occurrences of a matcher's pattern, where n is equal to count, in a matcher's target by a given substitution, appending the result to a buffer.
The substitution starts from current matcher's position, current match not included.

replace

public void replace(CharSequence text,
                    Writer out)
             throws IOException

Throws:

IOException

replace

public void replace(char[] chars,
                    int off,
                    int len,
                    Writer out)
             throws IOException

Throws:

IOException

replace

public void replace(MatchResult res,
                    int group,
                    Writer out)
             throws IOException

Throws:

IOException

replace

public void replace(MatchResult res,
                    String groupName,
                    Writer out)
             throws IOException

Throws:

IOException

replace

public void replace(Reader in,
                    int length,
                    Writer out)
             throws IOException

Throws:

IOException

wrap

public static TextBuffer wrap(StringBuilder sb)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object