StringUtils (DataNucleus Core 4.1.17-SNAPSHOT API)

java.lang.Object
- org.datanucleus.util.StringUtils

```
public class StringUtils
extends Object
```
Utilities for String manipulation.

Constructor Summary

Constructors
Constructor and Description

StringUtils()

Constructors
Constructor and Description
`StringUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areStringsEqual(String str1, String str2)` Utility to tell if two strings are the same.
`static String`	`booleanArrayToString(boolean[] ba)` Utility to convert a boolean[] to a String.
`static String`	`collectionToString(Collection coll)` Converts the given collection of objects to string as a comma-separated list.
`static Set<String>`	`convertCommaSeparatedStringToSet(String str)` Converts the input comma-separated string into a Set of the individual strings, with each string trimmed and converted to UPPERCASE.
`static String`	`exponentialFormatBigDecimal(BigDecimal bd)` Formats the given BigDecimal value into a floating-point literal (like we find in SQL).
`static String`	`getDecodedStringFromURLString(String urlString)` Convenience method to decode a URL string for use (so spaces are allowed)
`static String`	`getEncodedURLStringFromString(String string)` Convenience method to encode a URL string for use (so spaces are allowed)
`static File`	`getFileForFilename(String filename)` Convenience method to get a File for the specified filename.
`static int`	`getIntValueForProperty(Properties props, String propName, int defaultValue)` Convenience method to extract an integer property value from a Properties file.
`static JarFile`	`getJarFileForFilename(String filename)` Convenience method to get a JarFile for the specified filename.
`static String`	`getNameOfClass(Class cls)`
`static String`	`getStringFromStackTrace(Throwable ex)` Convert an exception to a String with full stack trace
`static String`	`intArrayToString(int[] ia)` Utility to convert an int[] to a String.
`static boolean`	`isEmpty(String s)` check string is null or length is 0.
`static boolean`	`isWhitespace(String str)` Utility to check if a string is whitespace.
`static String`	`leftAlignedPaddedString(String input, int length)` Utility to return a left-aligned version of a string padded to the number of characters specified.
`static String`	`mapToString(Map map)` Converts the given map of objects to string as a comma-separated list.
`static boolean`	`notEmpty(String s)` check string is not null and length > 0.
`static String`	`objectArrayToString(Object[] arr)` Utility to convert an Object[] to a String.
`static String`	`removeSpecialTagsFromString(String str)` Method to return the input string with all special tags (end-of-line, tab, etc) replaced by spaces.
`static String`	`replaceAll(String theString, String toReplace, String replacement)` A more efficient version than `String.replace(CharSequence, CharSequence)` which uses Regex for the implementation and requires compilation for every execution.
`static String`	`rightAlignedPaddedString(String input, int length)` Utility to return a right-aligned version of a string padded to the number of characters specified.
`static String[]`	`split(String valuesString, String token)` Splits a list of values separated by a token
`static String`	`toJVMIDString(Object obj)` Utility to convert an object to a JVM type string.

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
  - getStringFromStackTrace
```
public static String getStringFromStackTrace(Throwable ex)
```
    Convert an exception to a String with full stack trace
    
    Parameters:
    
    ex - the exception
    
    Returns:
    
    a String with the full stacktrace error text
  - getFileForFilename
```
public static File getFileForFilename(String filename)
```
    Convenience method to get a File for the specified filename. Caters for URL-encoded characters in the filename (treatment of spaces on Windows etc)
    
    Parameters:
    
    filename - Name of file
    
    Returns:
    
    The File
  - getJarFileForFilename
```
public static JarFile getJarFileForFilename(String filename)
                                     throws IOException
```
    Convenience method to get a JarFile for the specified filename. Caters for URL-encoded characters in the filename (treatment of spaces on Windows etc)
    
    Parameters:
    
    filename - Name of file
    
    Returns:
    
    The JarFile
    
    Throws:
    
    IOException - if there is a problem opening the JarFile
  - getDecodedStringFromURLString
```
public static String getDecodedStringFromURLString(String urlString)
```
    Convenience method to decode a URL string for use (so spaces are allowed)
    
    Parameters:
    
    urlString - The URL string
    
    Returns:
    
    The string
  - getEncodedURLStringFromString
```
public static String getEncodedURLStringFromString(String string)
```
    Convenience method to encode a URL string for use (so spaces are allowed)
    
    Parameters:
    
    string - The string
    
    Returns:
    
    The encoded string
  - replaceAll
```
public static String replaceAll(String theString,
                                String toReplace,
                                String replacement)
```
    A more efficient version than String.replace(CharSequence, CharSequence) which uses Regex for the implementation and requires compilation for every execution.
    
    Parameters:
    
    theString - The string to use
    
    toReplace - The string to replace.
    
    replacement - The replacement string.
    
    Returns:
    
    The updated string after replacing.
  - isWhitespace
```
public static boolean isWhitespace(String str)
```
    Utility to check if a string is whitespace. If the string is null, returns true also.
    
    Parameters:
    
    str - The string to check
    
    Returns:
    
    Whether the string is just whitespace
  - areStringsEqual
```
public static boolean areStringsEqual(String str1,
                                      String str2)
```
    Utility to tell if two strings are the same. Extends the basic String 'equals' method by allowing for nulls.
    
    Parameters:
    
    str1 - The first string
    
    str2 - The second string
    
    Returns:
    
    Whether the strings are equal.
  - leftAlignedPaddedString
```
public static String leftAlignedPaddedString(String input,
                                             int length)
```
    Utility to return a left-aligned version of a string padded to the number of characters specified.
    
    Parameters:
    
    input - The input string
    
    length - The length desired
    
    Returns:
    
    The updated string
  - rightAlignedPaddedString
```
public static String rightAlignedPaddedString(String input,
                                              int length)
```
    Utility to return a right-aligned version of a string padded to the number of characters specified.
    
    Parameters:
    
    input - The input string
    
    length - The length desired
    
    Returns:
    
    The updated string
  - split
```
public static String[] split(String valuesString,
                             String token)
```
    Splits a list of values separated by a token
    
    Parameters:
    
    valuesString - the text to be splited
    
    token - the token
    
    Returns:
    
    an array with all values
  - convertCommaSeparatedStringToSet
```
public static Set<String> convertCommaSeparatedStringToSet(String str)
```
    Converts the input comma-separated string into a Set of the individual strings, with each string trimmed and converted to UPPERCASE.
    
    Parameters:
    
    str - The input string
    
    Returns:
    
    Set of the comma-separated strings that it is comprised of
  - toJVMIDString
```
public static String toJVMIDString(Object obj)
```
    Utility to convert an object to a JVM type string. Returns the same as would have been output from Object.toString() if the class hadn't overridden it.
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    The String version
  - booleanArrayToString
```
public static String booleanArrayToString(boolean[] ba)
```
    Utility to convert a boolean[] to a String.
    
    Parameters:
    
    ba - The boolean[]
    
    Returns:
    
    String version
  - intArrayToString
```
public static String intArrayToString(int[] ia)
```
    Utility to convert an int[] to a String.
    
    Parameters:
    
    ia - The int[]
    
    Returns:
    
    String version
  - objectArrayToString
```
public static String objectArrayToString(Object[] arr)
```
    Utility to convert an Object[] to a String.
    
    Parameters:
    
    arr - The Object[]
    
    Returns:
    
    String version
  - collectionToString
```
public static String collectionToString(Collection coll)
```
    Converts the given collection of objects to string as a comma-separated list. If the list is empty the string "<none>" is returned.
    
    Parameters:
    
    coll - collection of objects to be converted
    
    Returns:
    
    A string containing each object in the given collection, converted toString() and separated by commas.
  - getNameOfClass
```
public static String getNameOfClass(Class cls)
```
  - mapToString
```
public static String mapToString(Map map)
```
    Converts the given map of objects to string as a comma-separated list. If the map is empty the string "<none>" is returned.
    
    Parameters:
    
    map - Map to be converted
    
    Returns:
    
    A string containing each object in the given map, converted toString() and separated by commas.
  - getIntValueForProperty
```
public static int getIntValueForProperty(Properties props,
                                         String propName,
                                         int defaultValue)
```
    Convenience method to extract an integer property value from a Properties file.
    
    Parameters:
    
    props - The Properties
    
    propName - Name of the property
    
    defaultValue - The default value to use (in case not specified)
    
    Returns:
    
    The value
  - isEmpty
```
public static boolean isEmpty(String s)
```
    check string is null or length is 0.
    
    Parameters:
    
    s - check string
    
    Returns:
    
    return true if string is null or length is 0. return false other case.
  - notEmpty
```
public static boolean notEmpty(String s)
```
    check string is not null and length > 0.
    
    Parameters:
    
    s - check string
    
    Returns:
    
    return true if string isnot null and length greater than 0. return false other case.
  - exponentialFormatBigDecimal
```
public static String exponentialFormatBigDecimal(BigDecimal bd)
```
    Formats the given BigDecimal value into a floating-point literal (like we find in SQL). BigDecimal.toString() is not well suited to this purpose because it never uses E-notation, which causes some values with large exponents to be output as long strings with tons of zeroes in them.
    
    Parameters:
    
    bd - The number to format.
    
    Returns:
    
    The formatted String.
  - removeSpecialTagsFromString
```
public static String removeSpecialTagsFromString(String str)
```
    Method to return the input string with all special tags (end-of-line, tab, etc) replaced by spaces.
    
    Parameters:
    
    str - The string
    
    Returns:
    
    The cleaned up string

Class StringUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringUtils

Method Detail

getStringFromStackTrace

getFileForFilename

getJarFileForFilename

getDecodedStringFromURLString

getEncodedURLStringFromString

replaceAll

isWhitespace

areStringsEqual

leftAlignedPaddedString

rightAlignedPaddedString

split

convertCommaSeparatedStringToSet

toJVMIDString

booleanArrayToString

intArrayToString

objectArrayToString

collectionToString

getNameOfClass

mapToString

getIntValueForProperty

isEmpty

notEmpty

exponentialFormatBigDecimal

removeSpecialTagsFromString