StringUtils (Payara Project 4.1.2.174 API)

java.lang.Object
- com.sun.enterprise.util.StringUtils

```
public class StringUtils
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static String EOL

static String NEWLINE

Fields
Modifier and Type	Field and Description
`static String`	`EOL`
`static String`	`NEWLINE`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`cat(String separator, String... list)` Concatenate a list of strings, putting a separator in between each one.
`static String`	`escapeForHtml(String str)` Escape characters to use result in html.
`static String`	`formatSQLException(SQLException ex)` Returns a String containing SQLState, message and error code of exception and all sub-exceptions
`static String`	`getPenultimateDirName(String s)` e.g.
`static String`	`getProperty(String propName)` Get a system propety given a property name, possibly trying all combination of upercase, name mangling to get a value.
`static String`	`getStackTrace(Throwable t)` Gets a String version of the stack trace of an exception
`static boolean`	`isHex(char c)` Is this the char a valid hex digit?
`static boolean`	`isHex(String s)` Is this the String representation of a valid hex number? "5", "d", "D", "F454ecbb" all return true..
`static boolean`	`isToken(String s)` Returns true is the given string is of the form "${text}"
`static void`	`main(String[] args)`
`static String`	`makeFilePath(String[] strings, boolean addTrailing)` A utility to get the Operating System specific path from given array of Strings.
`static int`	`maxWidth(Vector v)` Find longest String in a vector of Strings...
`static String`	`nvl(String str)` If given `String` is `null` then returns empty `String` otherwise returns given `String`
`static boolean`	`ok(String s)` Returns true if a string is not null and has a non-zero length, false otherwise
`static String`	`padLeft(String s, int len)` Adds spaces to the front of a string to make it reach the specified length.
`static String`	`padRight(String s, int len)` Adds spaces to the end of a string to make it reach the specified length.
`static List<String>`	`parseStringList(String line)` Parses a string containing substrings separated from each other by the standard separator characters and returns a list of strings.
`static List<String>`	`parseStringList(String line, String sep)` Parses a string containing substrings separated from each other by the specified set of separator characters and returns a list of strings.
`static void`	`prepend(String[] ss, String what)` Puts a string before every element in an array
`static String`	`quotePathIfNecessary(String path)` Nightmares can result from using a path with a space in it! This method will enclose in double-quotes if needed.
`static String`	`quotePathIfNecessary(String path, char quoteChar)` Nightmares can result from using a path with a space in it! This method will enclose in the specified quote characters if needed.
`static String`	`removeChar(String strOrig, char c)` Remove a character from a String
`static String`	`removeEnclosingQuotes(String s)` Removes the quoting around a String.
`static String`	`replace(String s, String token, String replace)` Deprecated. Now part of `String` since JDK 1.5
`static int`	`safeLength(String s)` return the length of the String - or 0 if it's null
`static String`	`stripToken(String s)` Removes preceding `${` and trailing `}` from a String
`static void`	`testUpperCase()`
`static String[]`	`toLines(String s)` Converts a String into an array where every \n is a new used to signal a new element in the array
`static String`	`toShortClassName(String className)` Returns the classname without package info
`static String`	`toString(Properties props)` Converts a `Properties` object to string
`static String`	`upperCaseFirstLetter(String s)` Converts the first letter of a string to upper case

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NEWLINE
```
public static final String NEWLINE
```
  - EOL
```
public static final String EOL
```
- Method Detail
  - safeLength
```
public static int safeLength(String s)
```
    return the length of the String - or 0 if it's null
    
    Parameters:
    
    s -
    
    Returns:
  - ok
```
public static boolean ok(String s)
```
    Returns true if a string is not null and has a non-zero length, false otherwise
    
    Parameters:
    
    s -
    
    Returns:
  - formatSQLException
```
public static String formatSQLException(SQLException ex)
```
    Returns a String containing SQLState, message and error code of exception and all sub-exceptions
    
    Parameters:
    
    ex -
    
    Returns:
  - maxWidth
```
public static int maxWidth(Vector v)
```
    Find longest String in a vector of Strings...
    
    Parameters:
    
    v -
    
    Returns:
  - isHex
```
public static boolean isHex(String s)
```
    Is this the String representation of a valid hex number? "5", "d", "D", "F454ecbb" all return true..
    
    Parameters:
    
    s. -
  - isHex
```
public static boolean isHex(char c)
```
    Is this the char a valid hex digit?
    Can be upper or lower case
    
    Parameters:
    
    c -
    
    Returns:
  - getPenultimateDirName
```
public static String getPenultimateDirName(String s)
```
    e.g. input: "a/b/c/d/foobar.txt" output: "d"
    
    Parameters:
    
    s -
    
    Returns:
  - toShortClassName
```
public static String toShortClassName(String className)
```
    Returns the classname without package info
    i.e. java.lang.String would return String
    
    Parameters:
    
    className - The classname to convert. Note that there is no checking that this is a valid classname.
    
    Returns:
  - padRight
```
public static String padRight(String s,
                              int len)
```
    Adds spaces to the end of a string to make it reach the specified length.
    If the string is longer than the padded length then this function will return the original string.
    
    Parameters:
    
    s - String to pad
    
    len - The length of the string with added padding
    
    Returns:
    
    The padded string
  - padLeft
```
public static String padLeft(String s,
                             int len)
```
    Adds spaces to the front of a string to make it reach the specified length.
    If the string is longer than the padded length then this function will return the original string.
    
    Parameters:
    
    s - String to pad
    
    len - The length of the string with added padding
    
    Returns:
    
    The padded string
  - toLines
```
public static String[] toLines(String s)
```
    Converts a String into an array where every \n is a new used to signal a new element in the array
    
    Parameters:
    
    s -
    
    Returns:
  - prepend
```
public static void prepend(String[] ss,
                           String what)
```
    Puts a string before every element in an array
    i.e. prepend(new String["foo", "bar"],"not ") would result in String["not foo", "not bar"]
    
    Parameters:
    
    ss -
    
    what -
  - upperCaseFirstLetter
```
public static String upperCaseFirstLetter(String s)
```
    Converts the first letter of a string to upper case
    
    Parameters:
    
    s -
    
    Returns:
  - replace
```
public static String replace(String s,
                             String token,
                             String replace)
```
    Deprecated. Now part of String since JDK 1.5
    
    Replaces the first instance of a token within a string
    
    Parameters:
    
    s - The string to operate on
    
    token - the token to be replaced
    
    replace - the new value
    
    Returns:
    
    See Also:
    
    String.replace(CharSequence, CharSequence), String.replaceFirst(String, String)
  - toString
```
public static String toString(Properties props)
```
    Converts a Properties object to string
    If there it is empty then this will return "No entries". Otherwise it will be in the form of "key= value" with each property on a new line.
    
    Parameters:
    
    props -
    
    Returns:
  - main
```
public static void main(String[] args)
```
  - testUpperCase
```
public static void testUpperCase()
```
  - makeFilePath
```
public static String makeFilePath(String[] strings,
                                  boolean addTrailing)
```
    A utility to get the Operating System specific path from given array of Strings.
    
    Parameters:
    
    strings - an array of Strings participating in the path.
    
    addTrailing - a boolean that determines whether the returned String should have a trailing File Separator character. None of the strings may be null or empty String. An exception is thrown.
    
    Returns:
    
    a String that concatenates these Strings and gets a path. Returns a null if the array is null or contains no elements.
    
    Throws:
    
    IllegalArgumentException - if any of the arguments is null or is an empty string.
  - parseStringList
```
public static List<String> parseStringList(String line)
```
    Parses a string containing substrings separated from each other by the standard separator characters and returns a list of strings. Splits the string line into individual string elements separated by the field separators, and returns these individual strings as a list of strings. The individual string elements are trimmed of leading and trailing whitespace. Only non-empty strings are returned in the list.
    
    Parameters:
    
    line - The string to split
    
    Returns:
    
    Returns the list containing the individual strings that the input string was split into.
  - parseStringList
```
public static List<String> parseStringList(String line,
                                           String sep)
```
    Parses a string containing substrings separated from each other by the specified set of separator characters and returns a list of strings. Splits the string line into individual string elements separated by the field separators specified in sep, and returns these individual strings as a list of strings. The individual string elements are trimmed of leading and trailing whitespace. Only non-empty strings are returned in the list.
    
    Parameters:
    
    line - The string to split
    
    sep - The list of separators to use for determining where the string should be split. If null, then the standard separators (see StringTokenizer javadocs) are used.
    
    Returns:
    
    Returns the list containing the individual strings that the input string was split into.
  - getProperty
```
public static String getProperty(String propName)
```
    Get a system propety given a property name, possibly trying all combination of upercase, name mangling to get a value.
    
    Parameters:
    
    propName - the approximate system property name
    
    Returns:
    
    the property value if found, null otherwise
  - removeChar
```
public static String removeChar(String strOrig,
                                char c)
```
    Remove a character from a String
    
    Parameters:
    
    strOrig - original string
    
    c - character to remove from the string
    
    Returns:
    
    String with specified characters removed
  - getStackTrace
```
public static String getStackTrace(Throwable t)
```
    Gets a String version of the stack trace of an exception
    
    Parameters:
    
    t -
    
    Returns:
  - isToken
```
public static final boolean isToken(String s)
```
    Returns true is the given string is of the form "${text}"
    
    Parameters:
    
    s -
    
    Returns:
  - stripToken
```
public static final String stripToken(String s)
```
    Removes preceding ${ and trailing } from a String
    
    Parameters:
    
    s -
    
    Returns:
  - cat
```
public static String cat(String separator,
                         String... list)
```
    Concatenate a list of strings, putting a separator in between each one. If the list is one string, then the separator is not used. The separator will never be added to the start or end of the returned string. When empty or null strings are encountered in the list of strings they are ignore.
    
    Parameters:
    
    separator - Separator to use between concatenated strings
    
    list - List of strings to concatenate together
    
    Returns:
    
    String created by concatenating provided strings
  - removeEnclosingQuotes
```
public static String removeEnclosingQuotes(String s)
```
    Removes the quoting around a String.
    
    Parameters:
    
    s - The String that may have enclosing quotes
    
    Returns:
    
    The String resulting from removing the enclosing quotes
  - quotePathIfNecessary
```
public static String quotePathIfNecessary(String path)
```
    Nightmares can result from using a path with a space in it! This method will enclose in double-quotes if needed.
    
    Parameters:
    
    path -
    
    Returns:
  - quotePathIfNecessary
```
public static String quotePathIfNecessary(String path,
                                          char quoteChar)
```
    Nightmares can result from using a path with a space in it! This method will enclose in the specified quote characters if needed.
    
    Parameters:
    
    path -
    
    quoteChar -
    
    Returns:
  - escapeForHtml
```
public static String escapeForHtml(String str)
```
    Escape characters to use result in html.
    
    Chars Escape sequence
    
    < <
    
    > >
    
    & &
    
    " "
    
    \t
    
    Parameters:
    
    str -
    
    Returns:
  - nvl
```
public static String nvl(String str)
```
    If given String is null then returns empty String otherwise returns given String
    
    Parameters:
    
    str -
    
    Returns:

Chars	Escape sequence
<	<
>	>
&	&
"	"
\t

Class StringUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEWLINE

EOL

Method Detail

safeLength

ok

formatSQLException

maxWidth

isHex

isHex

getPenultimateDirName

toShortClassName

padRight

padLeft

toLines

prepend

upperCaseFirstLetter

replace

toString

main

testUpperCase

makeFilePath

parseStringList

parseStringList

getProperty

removeChar

getStackTrace

isToken

stripToken

cat

removeEnclosingQuotes

quotePathIfNecessary

quotePathIfNecessary

escapeForHtml

nvl