Class StringUtils
- java.lang.Object
-
- org.apache.velocity.util.StringUtils
-
public class StringUtils extends java.lang.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 685685 2008-08-13 21:43:27Z nbubna $
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
EOL
Line separator for the OS we are operating on.
-
Constructor Summary
Constructors Constructor Description StringUtils()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
allEmpty(java.util.List list)
Check to see if all the string objects passed in are empty.static java.lang.String
capitalizeFirstLetter(java.lang.String data)
Capitalize the first letter but leave the rest as they are.static java.lang.String
chop(java.lang.String s, int i)
Chop i characters off the end of a string.static java.lang.String
chop(java.lang.String s, int i, java.lang.String eol)
Chop i characters off the end of a string.static java.lang.String
collapseNewlines(java.lang.String argStr)
Remove/collapse multiple newline characters.static java.lang.String
collapseSpaces(java.lang.String argStr)
Remove/collapse multiple spaces.java.lang.String
concat(java.util.List list)
Concatenates a list of objects as a String.static java.lang.String
fileContentsToString(java.lang.String file)
Read the contents of a file and place them in a string object.static java.lang.String
firstLetterCaps(java.lang.String data)
Makes the first letter caps and the rest lowercase.static java.lang.String
getPackageAsPath(java.lang.String pckge)
Return a package name as a relative path namestatic java.lang.String
normalizePath(java.lang.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 java.lang.String
nullTrim(java.lang.String s)
Trim the string, but pass a null through.static java.lang.String
removeAndHump(java.lang.String data)
'Camels Hump' replacement of underscores.static java.lang.String
removeAndHump(java.lang.String data, java.lang.String replaceThis)
'Camels Hump' replacement.static java.lang.String
removeUnderScores(java.lang.String data)
Deprecated.Use the org.apache.commons.util.StringUtils class instead.java.lang.String
select(boolean state, java.lang.String trueString, java.lang.String falseString)
If state is true then return the trueString, else return the falseString.static java.lang.String[]
split(java.lang.String line, java.lang.String delim)
Create a string array from a string separated by delimstatic java.lang.String
stackTrace(java.lang.Throwable e)
Returns the output of printStackTrace as a String.static java.lang.StringBuffer
stringSubstitution(java.lang.String argStr, java.util.Hashtable vars)
static java.lang.StringBuffer
stringSubstitution(java.lang.String argStr, java.util.Map vars)
Perform a series of substitutions.static java.lang.String
sub(java.lang.String line, java.lang.String oldString, java.lang.String newString)
Replaces all instances of oldString with newString in line.static java.util.List
trimStrings(java.util.List list)
Trim all strings in a List.
-
-
-
Method Detail
-
concat
public java.lang.String concat(java.util.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 java.lang.String getPackageAsPath(java.lang.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 java.lang.String removeUnderScores(java.lang.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
becomesFooBar
butfoo_barBar
becomesFooBarbar
.- Parameters:
data
- string to remove underscores from.- Returns:
- String
-
removeAndHump
public static java.lang.String removeAndHump(java.lang.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
becomesFooBarBar
.- Parameters:
data
- string to hump- Returns:
- String
-
removeAndHump
public static java.lang.String removeAndHump(java.lang.String data, java.lang.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
becomesFooBarBar
.- Parameters:
data
- string to humpreplaceThis
- string to be replaced- Returns:
- String
-
firstLetterCaps
public static java.lang.String firstLetterCaps(java.lang.String data)
Makes the first letter caps and the rest lowercase.
For example
fooBar
becomesFoobar
.- Parameters:
data
- capitalize this- Returns:
- String
-
capitalizeFirstLetter
public static java.lang.String capitalizeFirstLetter(java.lang.String data)
Capitalize the first letter but leave the rest as they are.
For example
fooBar
becomesFooBar
.- Parameters:
data
- capitalize this- Returns:
- String
-
split
public static java.lang.String[] split(java.lang.String line, java.lang.String delim)
Create a string array from a string separated by delim- Parameters:
line
- the line to splitdelim
- the delimter to split by- Returns:
- a string array of the split fields
-
chop
public static java.lang.String chop(java.lang.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 java.lang.String chop(java.lang.String s, int i, java.lang.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 java.lang.StringBuffer stringSubstitution(java.lang.String argStr, java.util.Hashtable vars)
- Parameters:
argStr
-vars
-- Returns:
- Substituted String.
-
stringSubstitution
public static java.lang.StringBuffer stringSubstitution(java.lang.String argStr, java.util.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 stringvars
- name/value pairs used for substitution- Returns:
- String target string with replacements.
-
fileContentsToString
public static java.lang.String fileContentsToString(java.lang.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 java.lang.String collapseNewlines(java.lang.String argStr)
Remove/collapse multiple newline characters.- Parameters:
argStr
- string to collapse newlines in.- Returns:
- String
-
collapseSpaces
public static java.lang.String collapseSpaces(java.lang.String argStr)
Remove/collapse multiple spaces.- Parameters:
argStr
- string to remove multiple spaces from.- Returns:
- String
-
sub
public static final java.lang.String sub(java.lang.String line, java.lang.String oldString, java.lang.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 java.lang.String stackTrace(java.lang.Throwable e)
Returns the output of printStackTrace as a String.- Parameters:
e
- A Throwable.- Returns:
- A String.
-
normalizePath
public static final java.lang.String normalizePath(java.lang.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), returnnull
instead.- Parameters:
path
- Path to be normalized- Returns:
- String normalized path
-
select
public java.lang.String select(boolean state, java.lang.String trueString, java.lang.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(java.util.List list)
Check to see if all the string objects passed in are empty.- Parameters:
list
- A list ofString
objects.- Returns:
- Whether all strings are empty.
-
trimStrings
public static java.util.List trimStrings(java.util.List list)
Trim all strings in a List. Changes the strings in the existing list.- Parameters:
list
-- Returns:
- List of trimmed strings.
- Since:
- 1.5
-
nullTrim
public static java.lang.String nullTrim(java.lang.String s)
Trim the string, but pass a null through.- Parameters:
s
-- Returns:
- List of trimmed Strings.
- Since:
- 1.5
-
-