StringUtil

java.lang.Object
- org.pentaho.di.core.util.StringUtil

```
public class StringUtil
extends Object
```
A collection of utilities to manipulate strings.

Author:

wdeclerc

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CRLF`
`static String`	`EMPTY_STRING`
`static String`	`FIELD_CLOSE`
`static String`	`FIELD_OPEN`
`static String`	`HEX_CLOSE`
`static String`	`HEX_OPEN`
`static String`	`INDENTCHARS`
`static String[]`	`SYSTEM_PROPERTIES`
`static String`	`UNIX_CLOSE`
`static String`	`UNIX_OPEN`
`static String`	`WINDOWS_CLOSE`
`static String`	`WINDOWS_OPEN`

Constructor Summary

Constructors
Constructor and Description

StringUtil()

Constructors
Constructor and Description
`StringUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`environmentSubstitute(String aString, Map<String,String> systemProperties)` Substitutes variables in `aString` with the environment values in the system properties
`static String`	`generateRandomString(int length, String prefix, String postfix, boolean uppercase)`
`static String`	`getFormattedDateTime(Date date)` Giving back a date/time string in the format following the rule from the most to the least significant
`static String`	`getFormattedDateTime(Date date, boolean milliseconds)` Giving back a date/time string in the format following the rule from the most to the least significant
`static String`	`getFormattedDateTimeNow()` Giving back the actual time as a date/time string in the format following the rule from the most to the least significant
`static String`	`getFormattedDateTimeNow(boolean milliseconds)` Giving back the actual time as a date/time string in the format following the rule from the most to the least significant
`static String`	`getIndent(int indentLevel)`
`static void`	`getUsedVariables(String aString, List<String> list, boolean includeSystemVariables)`
`static String`	`getVariableName(String variable)` remove specification from variable
`static String`	`initCap(String st)`
`static boolean`	`IsDate(String str)`
`static boolean`	`IsDate(String str, String mask)`
`static boolean`	`isEmpty(String string)` Check if the string supplied is empty.
`static boolean`	`isEmpty(StringBuilder string)` Check if the StringBuilder supplied is empty.
`static boolean`	`IsInteger(String str)`
`static boolean`	`IsNumber(String str)`
`static boolean`	`isSystemVariable(String aString)`
`static boolean`	`isVariable(String variable)`
`static Date`	`str2dat(String arg0, String arg1, String val)`
`static double`	`str2num(String pattern, String decimal, String grouping, String currency, String value)`
`static String`	`substitute(String aString, Map<String,String> variablesValues, String open, String close)` Substitutes variables in `aString`.
`static String`	`substitute(String aString, Map<String,String> variablesValues, String open, String close, int recursion)` Substitutes variables in `aString`.
`static String`	`substituteField(String aString, RowMetaInterface rowMeta, Object[] rowData)` Substitutes field values in `aString`.
`static String`	`substituteHex(String aString)` Substitutes hex values in `aString` and convert them to operating system char equivalents in the return string.
`static String`	`substituteUnix(String aString, Map<String,String> variables)` Substitutes variables in `aString`.
`static String`	`substituteWindows(String aString, Map<String,String> variables)` Substitutes variables in `aString`.

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

- Field Detail
  - UNIX_OPEN
```
public static final String UNIX_OPEN
```
    See Also:
    
    Constant Field Values
  - UNIX_CLOSE
```
public static final String UNIX_CLOSE
```
    See Also:
    
    Constant Field Values
  - WINDOWS_OPEN
```
public static final String WINDOWS_OPEN
```
    See Also:
    
    Constant Field Values
  - WINDOWS_CLOSE
```
public static final String WINDOWS_CLOSE
```
    See Also:
    
    Constant Field Values
  - HEX_OPEN
```
public static final String HEX_OPEN
```
    See Also:
    
    Constant Field Values
  - HEX_CLOSE
```
public static final String HEX_CLOSE
```
    See Also:
    
    Constant Field Values
  - FIELD_OPEN
```
public static final String FIELD_OPEN
```
    See Also:
    
    Constant Field Values
  - FIELD_CLOSE
```
public static final String FIELD_CLOSE
```
    See Also:
    
    Constant Field Values
  - CRLF
```
public static final String CRLF
```
    See Also:
    
    Constant Field Values
  - INDENTCHARS
```
public static final String INDENTCHARS
```
    See Also:
    
    Constant Field Values
  - EMPTY_STRING
```
public static final String EMPTY_STRING
```
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTIES
```
public static final String[] SYSTEM_PROPERTIES
```
- Constructor Detail
  - StringUtil
```
public StringUtil()
```
- Method Detail
  - substitute
```
public static String substitute(String aString,
                                Map<String,String> variablesValues,
                                String open,
                                String close)
```
    Substitutes variables in aString. Variable names are delimited by open and close strings. The values are retrieved from the given map.
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    variablesValues - a map containing the variable values. The keys are the variable names, the values are the variable values.
    
    open - the open delimiter for variables.
    
    close - the close delimiter for variables.
    
    Returns:
    
    the string with the substitution applied.
  - substitute
```
public static String substitute(String aString,
                                Map<String,String> variablesValues,
                                String open,
                                String close,
                                int recursion)
```
    Substitutes variables in aString. Variable names are delimited by open and close strings. The values are retrieved from the given map.
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    variablesValues - a map containg the variable values. The keys are the variable names, the values are the variable values.
    
    open - the open delimiter for variables.
    
    close - the close delimiter for variables.
    
    recursion - the number of recursion (internal counter to avoid endless loops)
    
    Returns:
    
    the string with the substitution applied.
  - substituteHex
```
public static String substituteHex(String aString)
```
    Substitutes hex values in aString and convert them to operating system char equivalents in the return string. Format is $[01] or $[6F,FF,00,1F] Example: "This is a hex encoded six digits number 123456 in this string: $[31,32,33,34,35,36]"
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    Returns:
    
    the string with the substitution applied.
  - environmentSubstitute
```
public static final String environmentSubstitute(String aString,
                                                 Map<String,String> systemProperties)
```
    Substitutes variables in aString with the environment values in the system properties
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    systemProperties - the system properties to use
    
    Returns:
    
    the string with the substitution applied.
  - substituteUnix
```
public static String substituteUnix(String aString,
                                    Map<String,String> variables)
```
    Substitutes variables in aString. Variables are of the form "${}", following the Unix scripting convention. The values are retrieved from the given map.
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    variables - a map containg the variable values. The keys are the variable names, the values are the variable values.
    
    Returns:
    
    the string with the substitution applied.
  - substituteWindows
```
public static String substituteWindows(String aString,
                                       Map<String,String> variables)
```
    Substitutes variables in aString. Variables are of the form "%%%%", following the Windows convention. The values are retrieved from the given map.
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    variables - a map containg the variable values. The keys are the variable names, the values are the variable values.
    
    Returns:
    
    the string with the substitution applied.
  - substituteField
```
public static String substituteField(String aString,
                                     RowMetaInterface rowMeta,
                                     Object[] rowData)
                              throws KettleValueException
```
    Substitutes field values in aString. Field values are of the form "?{}". The values are retrieved from the specified row. Please note that the getString() method is used to convert to a String, for all values in the row.
    
    Parameters:
    
    aString - the string on which to apply the substitution.
    
    rowMeta - The row metadata to use.
    
    rowData - The row data to use
    
    Returns:
    
    the string with the substitution applied.
    
    Throws:
    
    KettleValueException - In case there is a String conversion error
  - isSystemVariable
```
public static boolean isSystemVariable(String aString)
```
  - getUsedVariables
```
public static void getUsedVariables(String aString,
                                    List<String> list,
                                    boolean includeSystemVariables)
```
  - generateRandomString
```
public static final String generateRandomString(int length,
                                                String prefix,
                                                String postfix,
                                                boolean uppercase)
```
  - initCap
```
public static String initCap(String st)
```
  - str2num
```
public static double str2num(String pattern,
                             String decimal,
                             String grouping,
                             String currency,
                             String value)
                      throws KettleValueException
```
    Throws:
    
    KettleValueException
  - isEmpty
```
public static final boolean isEmpty(String string)
```
    Check if the string supplied is empty. A String is empty when it is null or when the length is 0
    
    Parameters:
    
    string - The string to check
    
    Returns:
    
    true if the string supplied is empty
  - isEmpty
```
public static final boolean isEmpty(StringBuilder string)
```
    Check if the StringBuilder supplied is empty. A StringBuilder is empty when it is null or when the length is 0
    
    Parameters:
    
    string - The StringBuilder to check
    
    Returns:
    
    true if the StringBuilder supplied is empty
  - str2dat
```
public static Date str2dat(String arg0,
                           String arg1,
                           String val)
                    throws KettleValueException
```
    Throws:
    
    KettleValueException
  - getIndent
```
public static String getIndent(int indentLevel)
```
  - getFormattedDateTime
```
public static String getFormattedDateTime(Date date)
```
    Giving back a date/time string in the format following the rule from the most to the least significant
    
    Parameters:
    
    date - the date to convert
    
    Returns:
    
    a string in the form yyyddMM_hhmmss
  - getFormattedDateTime
```
public static String getFormattedDateTime(Date date,
                                          boolean milliseconds)
```
    Giving back a date/time string in the format following the rule from the most to the least significant
    
    Parameters:
    
    date - the date to convert
    
    milliseconds - true when milliseconds should be added
    
    Returns:
    
    a string in the form yyyddMM_hhmmssSSS (milliseconds will be optional)
  - getFormattedDateTimeNow
```
public static String getFormattedDateTimeNow()
```
    Giving back the actual time as a date/time string in the format following the rule from the most to the least significant
    
    Returns:
    
    a string in the form yyyddMM_hhmmss
  - getFormattedDateTimeNow
```
public static String getFormattedDateTimeNow(boolean milliseconds)
```
    Giving back the actual time as a date/time string in the format following the rule from the most to the least significant
    
    Parameters:
    
    milliseconds - true when milliseconds should be added
    
    Returns:
    
    a string in the form yyyddMM_hhmmssSSS (milliseconds will be optional)
  - IsInteger
```
public static boolean IsInteger(String str)
```
  - IsNumber
```
public static boolean IsNumber(String str)
```
  - IsDate
```
public static boolean IsDate(String str)
```
  - IsDate
```
public static boolean IsDate(String str,
                             String mask)
```
  - getVariableName
```
public static final String getVariableName(String variable)
```
    remove specification from variable
    
    Parameters:
    
    variable - the variable to look for, with the $ or % variable specification.
    
    Returns:
    
    the variable name
  - isVariable
```
public static boolean isVariable(String variable)
```
    Parameters:
    
    variable - the variable to look for, with the $ or % variable specification.
    
    Returns:
    
    true if the input is a variable, false otherwise

Class StringUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIX_OPEN

UNIX_CLOSE

WINDOWS_OPEN

WINDOWS_CLOSE

HEX_OPEN

HEX_CLOSE

FIELD_OPEN

FIELD_CLOSE

CRLF

INDENTCHARS

EMPTY_STRING

SYSTEM_PROPERTIES

Constructor Detail

StringUtil

Method Detail

substitute

substitute

substituteHex

environmentSubstitute

substituteUnix

substituteWindows

substituteField

isSystemVariable

getUsedVariables

generateRandomString

initCap

str2num

isEmpty

isEmpty

str2dat

getIndent

getFormattedDateTime

getFormattedDateTime

getFormattedDateTimeNow

getFormattedDateTimeNow

IsInteger

IsNumber

IsDate

IsDate

getVariableName

isVariable