org.apache.velocity.util

Class 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,v 1.16.8.1 2004/03/03 23:23:07 geirm Exp $

Author: Jason van Zyl Daniel Rall

Field Summary
static StringEOL
Line separator for the OS we are operating on.
static intEOL_LENGTH
Length of the line separator.
Method Summary
booleanallEmpty(List list)
Check to see if all the string objects passed in are empty.
static StringcapitalizeFirstLetter(String data)

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

static Stringchop(String s, int i)
Chop i characters off the end of a string.
static Stringchop(String s, int i, String eol)
Chop i characters off the end of a string.
static StringcollapseNewlines(String argStr)
Remove/collapse multiple newline characters.
static StringcollapseSpaces(String argStr)
Remove/collapse multiple spaces.
Stringconcat(List list)
Concatenates a list of objects as a String.
static StringfileContentsToString(String file)
Read the contents of a file and place them in a string object.
static StringfirstLetterCaps(String data)

Makes the first letter caps and the rest lowercase.

static StringgetPackageAsPath(String pckge)
Return a package name as a relative path name
static StringnormalizePath(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 StringremoveAndHump(String data)

'Camels Hump' replacement of underscores.

static StringremoveAndHump(String data, String replaceThis)

'Camels Hump' replacement.

static StringremoveUnderScores(String data)

Remove underscores from a string and replaces first letters with capitals.

Stringselect(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 StringstackTrace(Throwable e)
Returns the output of printStackTrace as a String.
static StringBufferstringSubstitution(String argStr, Hashtable vars)
static StringBufferstringSubstitution(String argStr, Map vars)
Perform a series of substitutions.
static Stringsub(String line, String oldString, String newString)
Replaces all instances of oldString with newString in line.

Field Detail

EOL

private static final String EOL
Line separator for the OS we are operating on.

EOL_LENGTH

private static final int EOL_LENGTH
Length of the line separator.

Method Detail

allEmpty

public boolean allEmpty(List list)
Check to see if all the string objects passed in are empty.

Parameters: list A list of java.lang.String objects.

Returns: Whether all strings are empty.

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

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: string 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: string String to chop. i Number of characters to chop. eol A String representing the EOL (end of line).

Returns: String with processed answer.

collapseNewlines

public static String collapseNewlines(String argStr)
Remove/collapse multiple newline characters.

Parameters: String string to collapse newlines in.

Returns: String

collapseSpaces

public static String collapseSpaces(String argStr)
Remove/collapse multiple spaces.

Parameters: String string to remove multiple spaces from.

Returns: String

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.

fileContentsToString

public static String fileContentsToString(String file)
Read the contents of a file and place them in a string object.

Parameters: String path to file.

Returns: String contents of the file.

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

getPackageAsPath

public static String getPackageAsPath(String pckge)
Return a package name as a relative path name

Parameters: String package name to convert to a directory.

Returns: String directory path.

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

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

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

select

public String select(boolean state, String trueString, String falseString)
If state is true then return the trueString, else return the falseString.

Parameters: boolean String trueString String falseString

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

stackTrace

public static final String stackTrace(Throwable e)
Returns the output of printStackTrace as a String.

Parameters: e A Throwable.

Returns: A String.

stringSubstitution

public static StringBuffer stringSubstitution(String argStr, Hashtable vars)

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: String target string Hashtable name/value pairs used for substitution

Returns: String target string with replacements.

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: String original string. String string in line to replace. String replace oldString with this.

Returns: String string with replacements.

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.