de.frame4j.text

Interface TextHelper.ReplaceVisitor

All Known Implementing Classes:

SVNkeys.MyTask, SVNkeysFilter

Enclosing class:

TextHelper

@MinDoc(copyright="Copyright 2003, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="see enclosing class TextHelper",
        lastModified="see enclosing class TextHelper",
        lastModifiedBy="see enclosing class TextHelper",
        usage="import",
        purpose="visitor pattern for text find and replace")
public static interface TextHelper.ReplaceVisitor

Visitor for text replacements.

An object of this type ReplaceVisitor implements one text replacement (of arbitrary complexity or simplicity) for multiple (multi spot, multi file e.g.) text replacements applying the visitor pattern. The applications / tools FuR, SVNkeys and SVNkeysFilter make ample use of this pattern and this interface.

© Copyright 2003, Albrecht Weinert

Since:

V2.05 (27.05.2003)

Author:

Albrecht Weinert

See Also:

TextHelper.fUr(CharSequence, StringBuilder, CharSequence, CharSequence, boolean)

Method Summary

Modifier and Type	Method and Description
String	visit(String opBr, String cont, String clBr) Evaluate the replacement text.

Method Detail

visit

String visit(String opBr,
             String cont,
             String clBr)

Evaluate the replacement text.

This method will be called for every single "visited" place in the text under work.

The content of this visited place will be referred to by (max.) three Strings:

• opening brace (pattern),
• the found text (itself),
• closing brace (pattern).

These can all be null, but (according to contract) at least one, mostly cont, should be non null.

The return value of this method is the new text, that shall replace all (!) three Strings constituting the visited place in the text under work.

That means, if the original text shall be kept unchanged at the visited place, do
return con3cat(opBr, cont, clBr);
or just return null.

The contract says, that returning null will also induce the caller to leave the place untouched. The visit then shall not be considered or counted as a replacement. If you want the visited spot emptied do
return ComVar.EMPTY_STRING;

Parameters:

opBr - opening brace

cont - content

clBr - closing brace

Returns:

replacement (for all three)

See Also:

TextHelper.con3cat(CharSequence, CharSequence, CharSequence)