fr.pixware.util
Class StringUtil

java.lang.Object
  fr.pixware.util.StringUtil

public class StringUtil
extends java.lang.Object

A collection of utility functions (static methods) operating on Strings and on lists of Strings. (What is called a list of Strings here is simply an array of Strings.)

Field Summary

static java.lang.String[]

EMPTY_LIST The empty list of Strings.

Constructor Summary

StringUtil()

Method Summary

static java.lang.String[]	append(java.lang.String[] strings, java.lang.String string) Inserts a String as last item of a list of Strings.
static java.lang.String	capitalize(java.lang.String string) Returns the specified string with its first character converted to upper case.
static boolean	contains(java.lang.String[] strings, java.lang.String string) Tests if list strings contains String string.
static java.lang.String	escape(java.lang.String string) Returns the specified string with all non-ASCII characters and non-printable ASCII characters replaced by the corresponding Java escape sequences (that is '\n', '?', etc).
static int	indexOf(java.lang.String[] strings, java.lang.String string) Searches String string within list strings.
static java.lang.String[]	insertAt(java.lang.String[] strings, java.lang.String string, int index) Inserts a String inside a list of Strings.
static java.lang.String	join(java.lang.String[] strings, char separatorChar) Joins the items of the specified list of Strings using specified separator char.
static java.lang.String	join(java.lang.String[] strings, java.lang.String separator) Joins the items of the specified list of Strings using specified separator String.
static void	main(java.lang.String[] args) A simple test for escape(java.lang.String) and unescape(java.lang.String).
static java.lang.String[]	prepend(java.lang.String[] strings, java.lang.String string) Inserts a String as first item of a list of Strings.
static java.lang.String	protect(java.lang.String string) Like escape(java.lang.String) but puts a double quote character ('\"') around the escaped string.
static java.lang.String[]	remove(java.lang.String[] strings, java.lang.String string) Removes a String from a list of Strings.
static java.lang.String[]	removeAt(java.lang.String[] strings, int index) Removes an item specified by its position from a list of Strings.
static java.lang.String	replaceAll(java.lang.String string, java.lang.String oldSub, java.lang.String newSub) Replaces substring oldSub by substring newSub inside String string.
static java.lang.String[]	split(java.lang.String string, char separatorChar) Splits String string at occurences of char separatorChar.
static java.lang.String	uncapitalize(java.lang.String string) Returns the specified string with its first character converted to lower case.
static java.lang.String	unescape(java.lang.String string) Returns the specified string with Java escape sequences (that is '\n', '?', etc) replaced by the corresponding character.
static java.lang.String	unprotect(java.lang.String string) Like unescape(java.lang.String) but removes the double quote characters ('\"'), if any, before unescaping the string.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LIST

public static final java.lang.String[] EMPTY_LIST

The empty list of Strings.

Constructor Detail

StringUtil

public StringUtil()

Method Detail

indexOf

public static int indexOf(java.lang.String[] strings,
                          java.lang.String string)

Searches String string within list strings.

Parameters:

strings - the list to be searched

string - the String to search for

Returns:

the index of the searched string within list or -1 if not found

contains

public static boolean contains(java.lang.String[] strings,
                               java.lang.String string)

Tests if list strings contains String string.

Parameters:

strings - the list to be searched

string - the String to search for

Returns:

true the string is found and false otherwise

insertAt

public static java.lang.String[] insertAt(java.lang.String[] strings,
                                          java.lang.String string,
                                          int index)

Inserts a String inside a list of Strings.

Parameters:

strings - the list where a String is to be inserted

string - the String to insert

index - the insertion index

Returns:

a list containing all the items of list strings plus String string inserted at position index

prepend

public static java.lang.String[] prepend(java.lang.String[] strings,
                                         java.lang.String string)

Inserts a String as first item of a list of Strings.

Parameters:

strings - the list where a String is to be inserted

string - the String to insert

Returns:

a list containing all the items of list strings plus String string inserted at its beginning

append

public static java.lang.String[] append(java.lang.String[] strings,
                                        java.lang.String string)

Inserts a String as last item of a list of Strings.

Parameters:

strings - the list where a String is to be inserted

string - the String to insert

Returns:

a list containing all the items of list strings plus String string inserted at its end

remove

public static java.lang.String[] remove(java.lang.String[] strings,
                                        java.lang.String string)

Removes a String from a list of Strings.

Parameters:

strings - the list where a String is to be removed

string - the String to remove

Returns:

a list containing all the items of list strings less String string if such String is contained in the list; the original list otherwise.

removeAt

public static java.lang.String[] removeAt(java.lang.String[] strings,
                                          int index)

Removes an item specified by its position from a list of Strings.

Parameters:

strings - the list where an item is to be removed

index - the position of the item to remove

Returns:

a list containing all the items of list strings less the item at position index.

protect

public static java.lang.String protect(java.lang.String string)

Like escape(java.lang.String) but puts a double quote character ('\"') around the escaped string.

escape

public static java.lang.String escape(java.lang.String string)

Returns the specified string with all non-ASCII characters and non-printable ASCII characters replaced by the corresponding Java escape sequences (that is '\n', '?', etc).

Parameters:

string - the String to be escaped

Returns:

the specified string with all non-ASCII characters and non-printable ASCII characters replaced by the corresponding Java escape sequences

unprotect

public static java.lang.String unprotect(java.lang.String string)

Like unescape(java.lang.String) but removes the double quote characters ('\"'), if any, before unescaping the string.

unescape

public static java.lang.String unescape(java.lang.String string)

Returns the specified string with Java escape sequences (that is '\n', '?', etc) replaced by the corresponding character.

Parameters:

string - the String to be unescaped

Returns:

the specified string with Java escape sequences replaced by the corresponding character

main

public static final void main(java.lang.String[] args)

A simple test for escape(java.lang.String) and unescape(java.lang.String).

capitalize

public static java.lang.String capitalize(java.lang.String string)

Returns the specified string with its first character converted to upper case.

Parameters:

string - the String to be processed

Returns:

the specified string with its first character converted to upper case

uncapitalize

public static java.lang.String uncapitalize(java.lang.String string)

Returns the specified string with its first character converted to lower case.

Parameters:

string - the String to be processed

Returns:

the specified string with its first character converted to lower case

split

public static java.lang.String[] split(java.lang.String string,
                                       char separatorChar)

Splits String string at occurences of char separatorChar.

Parameters:

string - the String to be split

separatorChar - the char where to split

Returns:

the list of substrings resulting from splitting String string at occurences of char separatorChar

Note that each occurence of separatorChar specifies the end of a substring. Therefore, the returned list may contain empty substrings if consecutive separatorChars are found in String string.

join

public static java.lang.String join(java.lang.String[] strings,
                                    char separatorChar)

Joins the items of the specified list of Strings using specified separator char.

Parameters:

strings - the list where items are to be joined

separatorChar - the char used to join items

Returns:

a string where all list items have been joined

join

public static java.lang.String join(java.lang.String[] strings,
                                    java.lang.String separator)

Joins the items of the specified list of Strings using specified separator String.

Parameters:

strings - the list where items are to be joined

separator - the String used to join items

Returns:

a string where all list items have been joined

replaceAll

public static java.lang.String replaceAll(java.lang.String string,
                                          java.lang.String oldSub,
                                          java.lang.String newSub)

Replaces substring oldSub by substring newSub inside String string.

Parameters:

string - the String where replacements are to be performed

oldSub - the substring to replace

newSub - the replacement substring

Returns:

a string where all replacements have been performed

See Also:

String.replace(char, char)