org.apache.velocity.util
クラス 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.

バージョン:

$Id: StringUtils.java,v 1.16 2002/02/20 11:35:11 geirm Exp $

作成者:

Jason van Zyl, Daniel Rall

フィールドの概要

private static java.lang.String	EOL Line separator for the OS we are operating on.
private static int	EOL_LENGTH Length of the line separator.

コンストラクタの概要

StringUtils()

メソッドの概要

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 name
static 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	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) 推奨されていません。 Use the org.apache.commons.util.StringUtils class instead. Using its firstLetterCaps() method in conjunction with a StringTokenizer will achieve the same result.
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 delim
static 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.

クラス java.lang.Object から継承したメソッド

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

フィールドの詳細

EOL

private static final java.lang.String EOL

Line separator for the OS we are operating on.

EOL_LENGTH

private static final int EOL_LENGTH

Length of the line separator.

コンストラクタの詳細

StringUtils

public StringUtils()

メソッドの詳細

concat

public java.lang.String concat(java.util.List list)

Concatenates a list of objects as a String.

パラメータ:

list - The list of objects to concatenate.

戻り値:

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

戻り値:

String directory path.

removeUnderScores

public static java.lang.String removeUnderScores(java.lang.String data)

推奨されていません。 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.

パラメータ:

data - string to remove underscores from.

戻り値:

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 becomes FooBarBar.

パラメータ:

data - string to hump

戻り値:

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 becomes FooBarBar.

パラメータ:

data - string to hump

replaceThis - string to be replaced

戻り値:

String

firstLetterCaps

public static java.lang.String firstLetterCaps(java.lang.String data)

Makes the first letter caps and the rest lowercase.

For example fooBar becomes Foobar.

パラメータ:

data - capitalize this

戻り値:

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 becomes FooBar.

パラメータ:

data - capitalize this

戻り値:

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

パラメータ:

line - the line to split

delim - the delimter to split by

戻り値:

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.

パラメータ:

i - Number of characters to chop.

戻り値:

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.

パラメータ:

i - Number of characters to chop.

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

戻り値:

String with processed answer.

stringSubstitution

public static java.lang.StringBuffer stringSubstitution(java.lang.String argStr,
                                                        java.util.Hashtable vars)

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.

戻り値:

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.

戻り値:

String contents of the file.

collapseNewlines

public static java.lang.String collapseNewlines(java.lang.String argStr)

Remove/collapse multiple newline characters.

戻り値:

String

collapseSpaces

public static java.lang.String collapseSpaces(java.lang.String argStr)

Remove/collapse multiple spaces.

戻り値:

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.

戻り値:

String string with replacements.

stackTrace

public static final java.lang.String stackTrace(java.lang.Throwable e)

Returns the output of printStackTrace as a String.

パラメータ:

e - A Throwable.

戻り値:

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), return null instead.

パラメータ:

path - Path to be normalized

戻り値:

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.

allEmpty

public boolean allEmpty(java.util.List list)

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

パラメータ:

list - A list of String objects.

戻り値:

Whether all strings are empty.