Package org.codelibs.jhighlight.tools

Class StringUtils

java.lang.Object

org.codelibs.jhighlight.tools.StringUtils

public abstract class StringUtils
extends Object

General purpose class containing common String manipulation methods.

Since:

1.0

Version:

$Revision: 3108 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com)

Method Summary

Modifier and Type	Method	Description
static String	convertTabsToSpaces(String line, int tabWidth)	Converts all tabs on a line to spaces according to the provided tab width.
static String	encodeHtml(String source)	Transforms a provided String object into a new string, containing only valid Html characters.
static boolean	filter(String name, Pattern[] included, Pattern[] excluded)	Checks if the name filters through a series of including and excluding regular expressions.
static boolean	filter(String name, Pattern included, Pattern excluded)	Checks if the name filters through an including and an excluding regular expression.
static String	repeat(String source, int count)	Creates a new string that contains the provided string a number of times.
static String	replace(String source, String stringToReplace, String replacementString)	Searches for a string within a specified string in a case-sensitive manner and replaces every match with another string.
static String	replace(String source, String stringToReplace, String replacementString, boolean matchCase)	Searches for a string within a specified string and replaces every match with another string.
static ArrayList	split(String source, String seperator)	Splits a string into different parts, using a seperator string to detect the seperation boundaries in a case-sensitive manner.
static ArrayList	split(String source, String seperator, boolean matchCase)	Splits a string into different parts, using a seperator string to detect the seperation boundaries.

Methods inherited from class java.lang.Object

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

Method Detail

encodeHtml

public static String encodeHtml(String source)

Transforms a provided String object into a new string, containing only valid Html characters.

Parameters:

source - The string that has to be transformed into a valid Html string.

Returns:

The encoded String object.

Since:

1.0

filter

public static boolean filter(String name,
                             Pattern included,
                             Pattern excluded)

Checks if the name filters through an including and an excluding regular expression.

Parameters:

name - The String that will be filtered.

included - The regular expressions that needs to succeed

excluded - The regular expressions that needs to fail

Returns:

true if the name filtered through correctly; or

false otherwise.

Since:

1.0

filter

public static boolean filter(String name,
                             Pattern[] included,
                             Pattern[] excluded)

Checks if the name filters through a series of including and excluding regular expressions.

Parameters:

name - The String that will be filtered.

included - An array of regular expressions that need to succeed

excluded - An array of regular expressions that need to fail

Returns:

true if the name filtered through correctly; or

false otherwise.

Since:

1.0

split

public static ArrayList split(String source,
                              String seperator)

Splits a string into different parts, using a seperator string to detect the seperation boundaries in a case-sensitive manner. The seperator will not be included in the list of parts.

Parameters:

source - The string that will be split into parts.

seperator - The seperator string that will be used to determine the parts.

Returns:

An ArrayList containing the parts as String objects.

Since:

1.0

split

public static ArrayList split(String source,
                              String seperator,
                              boolean matchCase)

Splits a string into different parts, using a seperator string to detect the seperation boundaries. The seperator will not be included in the list of parts.

Parameters:

source - The string that will be split into parts.

seperator - The seperator string that will be used to determine the parts.

matchCase - A boolean indicating if the match is going to be performed in a case-sensitive manner or not.

Returns:

An ArrayList containing the parts as String objects.

Since:

1.0

replace

public static String replace(String source,
                             String stringToReplace,
                             String replacementString)

Searches for a string within a specified string in a case-sensitive manner and replaces every match with another string.

Parameters:

source - The string in which the matching parts will be replaced.

stringToReplace - The string that will be searched for.

replacementString - The string that will replace each matching part.

Returns:

A new String object containing the replacement result.

Since:

1.0

replace

public static String replace(String source,
                             String stringToReplace,
                             String replacementString,
                             boolean matchCase)

Searches for a string within a specified string and replaces every match with another string.

Parameters:

source - The string in which the matching parts will be replaced.

stringToReplace - The string that will be searched for.

replacementString - The string that will replace each matching part.

matchCase - A boolean indicating if the match is going to be performed in a case-sensitive manner or not.

Returns:

A new String object containing the replacement result.

Since:

1.0

repeat

public static String repeat(String source,
                            int count)

Creates a new string that contains the provided string a number of times.

Parameters:

source - The string that will be repeated.

count - The number of times that the string will be repeated.

Returns:

A new String object containing the repeated concatenation result.

Since:

1.0

convertTabsToSpaces

public static String convertTabsToSpaces(String line,
                                         int tabWidth)

Converts all tabs on a line to spaces according to the provided tab width.

Parameters:

line - The line whose tabs have to be converted.

tabWidth - The tab width.

Returns:

A new String object containing the line with the replaced tabs.

Since:

1.0