org.gatein.common.text

Class TextTools

java.lang.Object

org.gatein.common.text.TextTools

public class TextTools
extends Object

Version:

$Revision: 1.1 $

Author:

Julien Viet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextTools.ConstantStringReplacementGenerator
static interface	TextTools.StringReplacementGenerator

Constructor Summary

Constructors

Constructor and Description
TextTools()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isAlphaNumeric(char c) Returns true if the char c is alpha numeric i.e it belongs to one of the following ranges [0,9], [A,Z] or [a,z]
static String	replace(String string, String pattern, String replacement) Replace occurence in a string.
static String	replaceAllInstancesOfBoundedString(String initial, String prefix, String suffix, String replacement) Same as replaceBoundedString(initial, prefix, suffix, replacement, true, false).
static String	replaceAllInstancesOfBoundedString(String initial, String prefix, String suffix, TextTools.StringReplacementGenerator generator)
static String	replaceBoundedString(String initial, String prefix, String suffix, String replacement, boolean replaceIfBoundedStringEmpty, boolean keepBoundaries)
static String	replaceBoundedString(String initial, String prefix, String suffix, String replacement, boolean replaceIfBoundedStringEmpty, boolean keepBoundaries, boolean suffixIsOptional)
static String	replaceBoundedString(String initial, String prefix, String suffix, TextTools.StringReplacementGenerator generator, boolean replaceIfBoundedStringEmpty, boolean keepBoundaries)
static String	replaceBoundedString(String initial, String prefix, String suffix, TextTools.StringReplacementGenerator generator, boolean replaceIfBoundedStringEmpty, boolean keepBoundaries, boolean suffixIsOptional) Replace instances of Strings delimited by the given prefix and suffix (hence, bounded) by a replacement String computed by the specified StringReplacementGenerator based on the current bounded String match.
static char	toHex(int z) Returns the hexadecimal value of the provided numeric value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextTools

public TextTools()

Method Detail

isAlphaNumeric

public static boolean isAlphaNumeric(char c)

Returns true if the char c is alpha numeric i.e it belongs to one of the following ranges [0,9], [A,Z] or [a,z]

Parameters:

c - the char to test

Returns:

true if c is alpha numeric

toHex

public static char toHex(int z)
                  throws IllegalArgumentException

Returns the hexadecimal value of the provided numeric value.

Parameters:

z - the numeric value to convert

Returns:

the hexadecimal char

Throws:

IllegalArgumentException - if the value is not between 0 and 15

replace

public static String replace(String string,
             String pattern,
             String replacement)

Replace occurence in a string.

Parameters:

string - the source string

pattern - the replaced pattern

replacement - the replacement text

Returns:

the new string

replaceAllInstancesOfBoundedString

public static String replaceAllInstancesOfBoundedString(String initial,
                                        String prefix,
                                        String suffix,
                                        String replacement)

Same as replaceBoundedString(initial, prefix, suffix, replacement, true, false).

Parameters:

initial -

prefix -

suffix -

replacement -

Returns:

replaceAllInstancesOfBoundedString

public static String replaceAllInstancesOfBoundedString(String initial,
                                        String prefix,
                                        String suffix,
                                        TextTools.StringReplacementGenerator generator)

replaceBoundedString

public static String replaceBoundedString(String initial,
                          String prefix,
                          String suffix,
                          String replacement,
                          boolean replaceIfBoundedStringEmpty,
                          boolean keepBoundaries)

replaceBoundedString

public static String replaceBoundedString(String initial,
                          String prefix,
                          String suffix,
                          String replacement,
                          boolean replaceIfBoundedStringEmpty,
                          boolean keepBoundaries,
                          boolean suffixIsOptional)

replaceBoundedString

public static String replaceBoundedString(String initial,
                          String prefix,
                          String suffix,
                          TextTools.StringReplacementGenerator generator,
                          boolean replaceIfBoundedStringEmpty,
                          boolean keepBoundaries)

replaceBoundedString

public static String replaceBoundedString(String initial,
                          String prefix,
                          String suffix,
                          TextTools.StringReplacementGenerator generator,
                          boolean replaceIfBoundedStringEmpty,
                          boolean keepBoundaries,
                          boolean suffixIsOptional)

Replace instances of Strings delimited by the given prefix and suffix (hence, bounded) by a replacement String computed by the specified StringReplacementGenerator based on the current bounded String match. It is possible to specify whether the substitution will happen only if the delimited String is non-empty by setting replaceIfBoundedStringEmpty to false. It is also possible to keep the boundaries (prefix and suffix) after the substitution by setting keepBoundaries to true.
Note that it is possible to specify that the suffix is optional, will be passed as a match on to the specified StringReplacementGenerator and be replaced.
See org.gatein.common.StringTestCase.testReplaceBoundedString() for usage details.

Parameters:

initial - the String in which we want to replace bounded Strings

prefix - the prefix used identify the beginning of the String targeted for replacement

suffix - the suffix used to identify the end of the String targeted for replacement

generator - the StringReplacementGeneraot generating replacements based on the current bounded String match

replaceIfBoundedStringEmpty - true to allow replacement of empty Strings (in essence, insertion of the replacement String between the prefix and suffix)

keepBoundaries - true to keep the prefix and suffix markers in the resulting String

suffixIsOptional - whether or not the suffix is optional

Returns:

a String where the Strings marked by prefix and suffix have been replaced by replacement