org.apache.velocity.util
Class StringUtils

java.lang.Object
  org.apache.velocity.util.StringUtils

public class StringUtils
extends Object

This class provides some methods for dynamically invoking methods in objects, and some string manipulation methods used by torque. The string methods will soon be moved into the turbine string utilities class.

Version:

$Id: StringUtils.java 463298 2006-10-12 16:10:32Z henning $

Author:

Jason van Zyl, Daniel Rall

Constructor Summary

StringUtils()

Method Summary

boolean	allEmpty(List list) Check to see if all the string objects passed in are empty.
static String	capitalizeFirstLetter(String data) Capitalize the first letter but leave the rest as they are.
static String	chop(String s, int i) Chop i characters off the end of a string.
static String	chop(String s, int i, String eol) Chop i characters off the end of a string.
static String	collapseNewlines(String argStr) Remove/collapse multiple newline characters.
static String	collapseSpaces(String argStr) Remove/collapse multiple spaces.
String	concat(List list) Concatenates a list of objects as a String.
static String	fileContentsToString(String file) Read the contents of a file and place them in a string object.
static String	firstLetterCaps(String data) Makes the first letter caps and the rest lowercase.
static String	getPackageAsPath(String pckge) Return a package name as a relative path name
static String	normalizePath(String path) Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out.
static String	nullTrim(String s) Trim the string, but pass a null through.
static String	removeAndHump(String data) 'Camels Hump' replacement of underscores.
static String	removeAndHump(String data, String replaceThis) 'Camels Hump' replacement.
static String	removeUnderScores(String data) Deprecated. Use the org.apache.commons.util.StringUtils class instead. Using its firstLetterCaps() method in conjunction with a StringTokenizer will achieve the same result.
String	select(boolean state, String trueString, String falseString) If state is true then return the trueString, else return the falseString.
static String[]	split(String line, String delim) Create a string array from a string separated by delim
static String	stackTrace(Throwable e) Returns the output of printStackTrace as a String.
static StringBuffer	stringSubstitution(String argStr, Hashtable vars)
static StringBuffer	stringSubstitution(String argStr, Map vars) Perform a series of substitutions.
static String	sub(String line, String oldString, String newString) Replaces all instances of oldString with newString in line.
static List	trimStrings(List list) Trim all strings in a List.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringUtils

public StringUtils()

Method Detail

concat

public String concat(List list)

Concatenates a list of objects as a String.

Parameters:

list - The list of objects to concatenate.

Returns:

A text representation of the concatenated objects.

getPackageAsPath

public static String getPackageAsPath(String pckge)

Return a package name as a relative path name

Parameters:

pckge - package name to convert to a directory.

Returns:

String directory path.

removeUnderScores

public static String removeUnderScores(String data)

Deprecated. Use the org.apache.commons.util.StringUtils class instead. Using its firstLetterCaps() method in conjunction with a StringTokenizer will achieve the same result.

Remove underscores from a string and replaces first letters with capitals. Other letters are changed to lower case.

For example foo_bar becomes FooBar but foo_barBar becomes FooBarbar.

Parameters:

data - string to remove underscores from.

Returns:

String

removeAndHump

public static String removeAndHump(String data)

'Camels Hump' replacement of underscores.

Remove underscores from a string but leave the capitalization of the other letters unchanged.

For example foo_barBar becomes FooBarBar.

Parameters:

data - string to hump

Returns:

String

removeAndHump

public static String removeAndHump(String data,
                                   String replaceThis)

'Camels Hump' replacement.

Remove one string from another string but leave the capitalization of the other letters unchanged.

For example, removing "_" from foo_barBar becomes FooBarBar.

Parameters:

data - string to hump

replaceThis - string to be replaced

Returns:

String

firstLetterCaps

public static String firstLetterCaps(String data)

Makes the first letter caps and the rest lowercase.

For example fooBar becomes Foobar.

Parameters:

data - capitalize this

Returns:

String

capitalizeFirstLetter

public static String capitalizeFirstLetter(String data)

Capitalize the first letter but leave the rest as they are.

For example fooBar becomes FooBar.

Parameters:

data - capitalize this

Returns:

String

split

public static String[] split(String line,
                             String delim)

Create a string array from a string separated by delim

Parameters:

line - the line to split

delim - the delimter to split by

Returns:

a string array of the split fields

chop

public static String chop(String s,
                          int i)

Chop i characters off the end of a string. This method assumes that any EOL characters in String s and the platform EOL will be the same. A 2 character EOL will count as 1 character.

Parameters:

s - String to chop.

i - Number of characters to chop.

Returns:

String with processed answer.

chop

public static String chop(String s,
                          int i,
                          String eol)

Chop i characters off the end of a string. A 2 character EOL will count as 1 character.

Parameters:

s - String to chop.

i - Number of characters to chop.

eol - A String representing the EOL (end of line).

Returns:

String with processed answer.

stringSubstitution

public static StringBuffer stringSubstitution(String argStr,
                                              Hashtable vars)

Parameters:

argStr -

vars -

Returns:

Substituted String.

stringSubstitution

public static StringBuffer stringSubstitution(String argStr,
                                              Map vars)

Perform a series of substitutions. The substitions are performed by replacing $variable in the target string with the value of provided by the key "variable" in the provided hashtable.

Parameters:

argStr - target string

vars - name/value pairs used for substitution

Returns:

String target string with replacements.

fileContentsToString

public static String fileContentsToString(String file)

Read the contents of a file and place them in a string object.

Parameters:

file - path to file.

Returns:

String contents of the file.

collapseNewlines

public static String collapseNewlines(String argStr)

Remove/collapse multiple newline characters.

Parameters:

argStr - string to collapse newlines in.

Returns:

String

collapseSpaces

public static String collapseSpaces(String argStr)

Remove/collapse multiple spaces.

Parameters:

argStr - string to remove multiple spaces from.

Returns:

String

sub

public static final String sub(String line,
                               String oldString,
                               String newString)

Replaces all instances of oldString with newString in line. Taken from the Jive forum package.

Parameters:

line - original string.

oldString - string in line to replace.

newString - replace oldString with this.

Returns:

String string with replacements.

stackTrace

public static final String stackTrace(Throwable e)

Returns the output of printStackTrace as a String.

Parameters:

e - A Throwable.

Returns:

A String.

normalizePath

public static final String normalizePath(String path)

Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out. If the specified path attempts to go outside the boundaries of the current context (i.e. too many ".." path elements are present), return null instead.

Parameters:

path - Path to be normalized

Returns:

String normalized path

select

public String select(boolean state,
                     String trueString,
                     String falseString)

If state is true then return the trueString, else return the falseString.

Parameters:

state -

trueString -

falseString -

Returns:

Selected result.

allEmpty

public boolean allEmpty(List list)

Check to see if all the string objects passed in are empty.

Parameters:

list - A list of String objects.

Returns:

Whether all strings are empty.

trimStrings

public static List trimStrings(List list)

Trim all strings in a List. Changes the strings in the existing list.

Parameters:

list -

Returns:

List of trimmed strings.

nullTrim

public static String nullTrim(String s)

Trim the string, but pass a null through.

Parameters:

s -

Returns:

List of trimmed Strings.