ERXStringUtilities (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.foundation.ERXStringUtilities

```
public class ERXStringUtilities
extends Object
```
Collection of String utilities. Contains the base localization support.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static double`	`adjustement` holds the base adjustment for fuzzy matching
`static char[]`	`HEX_CHARS` Holds the chars for hex encoding
`static NSDictionary<String,String>`	`HTML_SAFE_UNESCAPES` Safe HTML entities to unescape (SYMBOL+ISO).
`static NSDictionary<String,String>`	`HTML_UNESCAPES` HTML entities to unescape (XML+SYMBOL+ISO).
`static NSDictionary<String,String>`	`ISO_UNESCAPES` ISO entities to unescape.
`static NSArray`	`SORT_ASCENDING` Holds the ascending `EOSortOrdering`s
`static NSArray`	`SORT_DESCENDING` Holds the ascending `EOSortOrdering`s
`static String`	`SpecialRegexCharacters` Holds characters that have special meaning for regex
`static NSDictionary<String,String>`	`SYMBOL_UNESCAPES` Symbol entities to unescape.
`static NSDictionary<String,String>`	`XML_UNESCAPES` XML entities to unescape.

Constructor Summary

Constructors
Constructor and Description

ERXStringUtilities()

Constructors
Constructor and Description
`ERXStringUtilities()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendSeparatorIfLastNot(char separator, char not, StringBuffer sb)` Utility method to append a character to a StringBuffer if the last character is not a certain character.
`static void`	`appendSeparatorIfLastNot(char separator, char not, StringBuilder sb)` Utility method to append a character to a StringBuilder if the last character is not a certain character.
`static Object`	`attributeCustomValueFromString(EOAttribute attr, String strVal, String encoding)` Attempts to convert string values for attributes into the appropriate value class for the attribute.
`static Number`	`attributeNumberValueFromString(EOAttribute attr, String strVal)` Attempts to convert string values for attributes into the appropriate value class for the attribute.
`static Object`	`attributeValueFromString(EOAttribute attr, String strVal, String encoding, Format formatter)` Attempts to convert string values for attributes into the appropriate value class for the attribute.
`static String`	`byteArrayToHexString(byte[] block)` Converts a byte array to hex string.
`static String`	`camelCaseToUnderscore(String camelString, boolean lowercase)` Converts a string in camel case to an underscore representation.
`static String`	`capitalize(String value)` Capitalizes a given string.
`static String`	`capitalizeAllWords(String value)` Capitalizes all the strings in a given string.
`static boolean`	`caseInsensitiveStartsWith(String stringToSearch, String prefix)` Tests if the string starts with the specified prefix ignoring case.
`static boolean`	`caseInsensitiveStartsWith(String stringToSearch, String prefix, int toffset)` Tests if the string starts with the specified prefix starting at the specified index ignoring case.
`static String`	`cleanString(String newString, NSArray<String> toBeCleaneds)` Given an initial string and an array of substrings, Removes any occurrences of any of the substrings from the initial string.
`static boolean`	`containsAnyCharacter(String source, String characters)` Checks if any of the characters specified in characters is contained in the string specified by source.
`static String`	`displayNameForKey(String key)` Calculates a default display name for a given key path.
`static String`	`dumpObject(Object object)` Creates a readable debug string for some data types (dicts, arrays, adaptorOperations, databaseOperations).
`static String`	`emptyStringForNull(String s)` Simple utility method that will return the string "" if the string passed in is null otherwise it will return the passed in string.
`static String`	`escape(char[] _escapeChars, char _escapeWith, String _sourceString)` Escapes the given characters with the given escape character in _sourceString.
`static String`	`escapeJavascriptApostrophes(String sourceString)` Escapes the apostrophes in a Javascript string with a backslash.
`static String`	`escapeNonBasicLatinChars(char c)`
`static String`	`escapeNonBasicLatinChars(String str)`
`static String`	`escapeNonXMLChars(String str)`
`static String`	`escapePCData(String pcdata)` Escapes the given PCDATA string as CDATA.
`static String`	`excelSafeCsvString(String s)` Removes line breaks and quotes the string if necessary
`static String`	`firstPropertyKeyInKeyPath(String keyPath)`
`static String`	`fromBytes(byte[] bytes, String encoding)` Utility to convert from bytes without the try/catch.
`static String`	`fromUTF8Bytes(byte[] bytes)` Utility to convert from UTF-8 bytes without the try/catch.
`static NSArray`	`fuzzyMatch(String name, String entityName, String propertyKey, String synonymsKey, com.webobjects.eocontrol.EOEditingContext ec, ERXFuzzyMatchCleaner cleaner, NSArray sortOrderings)` Fuzzy matching is useful for catching user entered typos.
`static String`	`getSimpleClassName(Class clazz)` "Borrowed" from 1.5's Class.getSimpleClassName
`static byte[]`	`hexStringToByteArray(String hexString)` Converts a even-length, hex-encoded String to a byte array.
`static void`	`indent(PrintWriter writer, int level)`
`static void`	`indent(StringBuffer sb, int level)`
`static int`	`indexOfNumericInString(String str)` Locate the the first numeric character in the given string.
`static int`	`indexOfNumericInString(String str, int fromIndex)` Locate the the first numeric character after `fromIndex` in the given string.
`static String`	`insertString(String destinationString, String contentToInsert, int insertOffset)` Inserts the a string into another string at a particular offset.
`static Integer`	`integerWithString(String s)` Calculates an Integer for a given string.
`static boolean`	`isBlank(String value)`
`static boolean`	`isNotBlank(String value)`
`static boolean`	`isValueInRange(int value, String rangeString)` Returns whether the given value falls in a range defined by the given string, which is in the format "1-5,100,500,800-1000".
`static String`	`keyPathWithoutFirstProperty(String keyPath)`
`static String`	`keyPathWithoutLastProperty(String keyPath)`
`static String`	`lastPropertyKeyInKeyPath(String keyPath)`
`static String`	`leftPad(String string, char padChar, int paddedLength)` Pads a string to the specified number of chars by adding the the given pad char on the left side.
`static String`	`localizedStringForKey(String key)` Gets a localized string for a given key in the application's Localizable strings file for the default language (English).
`static String`	`localizedStringForKey(String key, String framework)` Gets a localized string for a given key in a given framework's Localizable strings file for the default language (English).
`static String`	`localizedStringForKey(String key, String framework, NSArray languages)` Gets a localized string for a given key in a given framework's Localizable strings file using the array of languages as the search order for the key.
`static String`	`localizedTemplateStringWithObjectForKey(Object o, String key, String framework, NSArray languages)` Uses the method `localizedStringForKey` to retreive a template that is then parsed using the passed in object to produce a resulting string.
`static boolean`	`luhnCheck(String value)` A fast Luhn algorithm check.
`static String`	`maskStringWithCharacter(String arg, char mask, int beginIndex, int endIndex)` Masks a given string with a single character in the substring specified by the begin and end indexes.
`static String`	`matchCase(String originalString, String newString)` Returns a string case-matched against the original string.
`static byte[]`	`md5(String str, String encoding)` Generate an MD5 hash from a String.
`static String`	`md5Hex(String str, String encoding)` Generate an MD5 hash as hex from a String.
`static String`	`nullForEmptyString(String s)` Simple utility method that will return null if the string passed in is equal to "" otherwise it will return the passed in string.
`static int`	`numberOfOccurrencesOfCharInString(char c, String s)` Counts the number of occurrences of a particular `char` in a given string.
`static boolean`	`quicksilverContains(String _str, String _searchString)` Matches strings like Quicksilver (NullPointerException is matched by "NPE").
`static String`	`quote(String s, String quoteSymbol)` Quote the given string with the provided quote symbols
`static boolean`	`regionMatches(StringBuffer str, int toffset, String other, int ooffset, int len)` It's ridiculous that StringBuffer doesn't have a .regionMatches like String.
`static String`	`removeCharacters(String source, String characters)` Removes any character which is in characters from the source string.
`static String`	`removeExceptCharacters(String source, String characters)` Removes any character which is not in characters from the source string.
`static String`	`removeExtraDotsFromVersionString(String version)` Cleans up the given version string by removing extra dots(.), for example, 5.1.3 becomes 5.13, so that the string can be converted to a double or BigDecimal type easily.
`static String`	`removeHTMLTagsFromString(String s)` Removes all of the HTML tags from a given string.
`static String`	`removeSpaces(String aString)` Removes the spaces in a given string.
`static String`	`rightPad(String string, char padChar, int paddedLength)` Pads a string to the specified number of chars by adding the the given pad char on the right side.
`static String`	`safeIdentifierName(String source)` Convenience method to call safeIdentifierName(source, "_", '_')
`static String`	`safeIdentifierName(String source, String prefix)` Convenience method to call safeIdentifierName(source, prefix, '_')
`static String`	`safeIdentifierName(String source, String prefix, char replacement)` Converts source to be suitable for use as an identifier in JavaScript.
`static Integer`	`safeInteger(String s)` Wrapper for `Integer.valueOf(String)` that catches the NumberFormatException.
`static Long`	`safeLong(String s)` Wrapper for `Long.valueOf(String)` that catches the NumberFormatException.
`static void`	`setAdjustement(double newAdjustement)` Sets the base adjustment used for fuzzy matching
`static String`	`stringByAppendingCSSClass(String originalString, String cssClass)` Appends a CSS class to an existing (possibly null) CSS class string.
`static String`	`stringByTruncatingStringToByteLengthInEncoding(String inputString, int byteLength, String encoding)` This method takes a string and returns a string which is the first string such that the result byte length in the specified encoding does not exceed the byte limit.
`static boolean`	`stringContainsSpecialRegexCharacters(String s)` checks if the String contains a character that has a special meaning in regex.
`static boolean`	`stringEqualsString(String s1, String s2)`
`static String`	`stringFromDictionary(NSDictionary dict)` Same as NSPropertySerialization except it sorts on keys first.
`static String`	`stringFromInputStream(InputStream in)` Returns a string from the input stream using the default encoding.
`static String`	`stringFromInputStream(InputStream in, String encoding)` Returns a string from the input stream using the default encoding.
`static String`	`stringFromResource(String name, String extension, com.webobjects.foundation.NSBundle bundle)` Retrieves a given string for a given name, extension and bundle.
`static String`	`stringFromURL(URL url)` Returns a string from the contents of the given URL.
`static String`	`stringFromURL(URL url, String encoding)` Returns a string from the contents of the given URL.
`static boolean`	`stringIsNullOrEmpty(String s)` Simple test if the string is either null or equal to "".
`static boolean`	`stringIsParseableInteger(String s)` Tests if a given string object can be parsed into an integer.
`static String`	`stringWithContentsOfFile(File file)` Reads the contents of a file given by a path into a string.
`static String`	`stringWithContentsOfFile(String path)` Reads the contents of a file given by a path into a string.
`static String`	`stringWithNtimesString(int n, String s)` String multiplication.
`static String`	`stripHtml(String str, boolean convertChars)` Removes HTML characters from the given string.
`static String`	`strippedValue(String value, int length)` Returns the value stripped from HTML tags if escapeHTML is false.
`static byte[]`	`toBytes(String string, String encoding)` Utility to convert to bytes without the try/catch.
`static String`	`toHexString(char c)`
`static String`	`toHexString(String str)`
`static String`	`toLowerCase(String str)` This method runs about 20 times faster than java.lang.String.toLowerCase (and doesn't waste any storage when the result is equal to the input).
`static String`	`toString(Object[] array, String separator)` Returns a String by invoking toString() on each object from the array.
`static byte[]`	`toUTF8Bytes(String string)` Utility to convert to UTF-8 bytes without the try/catch.
`static String`	`trimString(String s)` Null-safe wrapper for java.lang.String.trim
`static String`	`trimZeroInFrontOfNumbers(String str)` trim leading 0 from a (Number) String
`static String`	`uncapitalize(String value)` Uncapitalizes a given string.
`static String`	`underscoreToCamelCase(String underscoreString, boolean capitalize)` Converts this_is_a_test to ThisIsATest
`static String`	`unescapeEntities(String string, Map<String,String> map)` Util to unescape entities.
`static String`	`unquote(String s, String quoteSymbol)` Remove the quote symbols from the given string
`static String`	`urlDecode(String string)` Utility to decode an URL without the try/catch.
`static String`	`urlEncode(String string)` Utility to encode an URL without the try/catch.
`static String`	`wordSafeTrimmedString(String trimmingString, int maxLenght)` Returns a string trimmed about at the max length you define without truncating the last word and adding "..." (if necessary)

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

- Field Detail
  - HEX_CHARS
```
public static final char[] HEX_CHARS
```
    Holds the chars for hex encoding
  - SORT_ASCENDING
```
public static final NSArray SORT_ASCENDING
```
    Holds the ascending EOSortOrderings
  - SORT_DESCENDING
```
public static final NSArray SORT_DESCENDING
```
    Holds the ascending EOSortOrderings
  - SpecialRegexCharacters
```
public static final String SpecialRegexCharacters
```
    Holds characters that have special meaning for regex
    
    See Also:
    
    Constant Field Values
  - adjustement
```
protected static double adjustement
```
    holds the base adjustment for fuzzy matching
  - XML_UNESCAPES
```
public static final NSDictionary<String,String> XML_UNESCAPES
```
    XML entities to unescape.
  - ISO_UNESCAPES
```
public static final NSDictionary<String,String> ISO_UNESCAPES
```
    ISO entities to unescape.
  - SYMBOL_UNESCAPES
```
public static final NSDictionary<String,String> SYMBOL_UNESCAPES
```
    Symbol entities to unescape.
  - HTML_SAFE_UNESCAPES
```
public static final NSDictionary<String,String> HTML_SAFE_UNESCAPES
```
    Safe HTML entities to unescape (SYMBOL+ISO). This still prevents injection attacks.
  - HTML_UNESCAPES
```
public static final NSDictionary<String,String> HTML_UNESCAPES
```
    HTML entities to unescape (XML+SYMBOL+ISO).
- Constructor Detail
  - ERXStringUtilities
```
public ERXStringUtilities()
```
- Method Detail
  - setAdjustement
```
public static void setAdjustement(double newAdjustement)
```
    Sets the base adjustment used for fuzzy matching
    
    Parameters:
    
    newAdjustement - factor to be used.
  - fuzzyMatch
```
public static NSArray fuzzyMatch(String name,
                                 String entityName,
                                 String propertyKey,
                                 String synonymsKey,
                                 com.webobjects.eocontrol.EOEditingContext ec,
                                 ERXFuzzyMatchCleaner cleaner,
                                 NSArray sortOrderings)
```
    Fuzzy matching is useful for catching user entered typos. For example if a user is searching for a company named 'Aple' within your application they aren't going to find it. Thus the idea of fuzzy matching, meaning you can define a threshold of 'how close can they be' type of thing.
    
    Parameters:
    
    name - to be matched against
    
    entityName - name of the entity to perform the match against.
    
    propertyKey - to be matched against
    
    synonymsKey - allows objects to have additional values to be matched against in addition to just the value of the propertyKey
    
    ec - context to fetch data in
    
    cleaner - object used to clean a string, for example the cleaner might strip out the words 'The' and 'Inc.'
    
    sortOrderings - can be either SORT_ASCENDING or SORT_DESCENDING to tell how the results should be sorted.
    
    Returns:
    
    an array of objects that match in a fuzzy manner the name passed in.
  - localizedStringForKey
```
public static String localizedStringForKey(String key)
```
    Gets a localized string for a given key in the application's Localizable strings file for the default language (English).
    
    Parameters:
    
    key - to be lookup in the strings file
    
    Returns:
    
    string value of the looked up key
  - localizedStringForKey
```
public static String localizedStringForKey(String key,
                                           String framework)
```
    Gets a localized string for a given key in a given framework's Localizable strings file for the default language (English).
    
    Parameters:
    
    key - to be lookup in the strings file
    
    framework - name, specify app or null to perform the lookup in the application's resources.
    
    Returns:
    
    string value of the looked up key
  - localizedStringForKey
```
public static String localizedStringForKey(String key,
                                           String framework,
                                           NSArray languages)
```
    Gets a localized string for a given key in a given framework's Localizable strings file using the array of languages as the search order for the key.
    
    Parameters:
    
    key - to be lookup in the strings file
    
    framework - name, specify app or null to perform the lookup in the application's resources.
    
    languages - array to search for the key in
    
    Returns:
    
    string value of the looked up key
  - localizedTemplateStringWithObjectForKey
```
public static String localizedTemplateStringWithObjectForKey(Object o,
                                                             String key,
                                                             String framework,
                                                             NSArray languages)
```
    Uses the method localizedStringForKey to retreive a template that is then parsed using the passed in object to produce a resulting string. The template parser used is ERXSimpleTemplateParser.
    
    Parameters:
    
    o - object used to resolve keys in the localized template
    
    key - to be lookup in the strings file
    
    framework - name, specify app or null to perform the lookup in the application's resources.
    
    languages - array to search for the key in
    
    Returns:
    
    localized template parsed and resolved with the given object.
  - stringWithContentsOfFile
```
public static String stringWithContentsOfFile(File file)
```
    Reads the contents of a file given by a path into a string.
    
    Parameters:
    
    file - path to the file in the file system
    
    Returns:
    
    the contents of the file in a string
  - stringWithContentsOfFile
```
public static String stringWithContentsOfFile(String path)
```
    Reads the contents of a file given by a path into a string.
    
    Parameters:
    
    path - to the file in the file system
    
    Returns:
    
    the contents of the file in a string
  - integerWithString
```
public static Integer integerWithString(String s)
```
    Calculates an Integer for a given string. The only advantage that this method has is to not throw a number format exception if the string is not correctly formatted. This method makes use of the ERXConstant.integerForString caching logic.
    
    Parameters:
    
    s - string to caclulate an Integer from
    
    Returns:
    
    parsed Integer from the string or null if the string is not correctly formed.
    
    See Also:
    
    er.extensions.eof.ERXConstant#integerForString(String)
  - stringIsParseableInteger
```
public static boolean stringIsParseableInteger(String s)
```
    Tests if a given string object can be parsed into an integer.
    
    Parameters:
    
    s - string to be parsed
    
    Returns:
    
    true if the string is not null and can be parsed to an int
  - safeInteger
```
public static Integer safeInteger(String s)
```
    Wrapper for Integer.valueOf(String) that catches the NumberFormatException.
    
    Parameters:
    
    s - string to convert to an Integer
    
    Returns:
    
    Integer or null if the string could not be parsed
  - safeLong
```
public static Long safeLong(String s)
```
    Wrapper for Long.valueOf(String) that catches the NumberFormatException.
    
    Parameters:
    
    s - string to convert to a Long
    
    Returns:
    
    Long or null if the string could not be parsed
  - stringFromResource
```
public static String stringFromResource(String name,
                                        String extension,
                                        com.webobjects.foundation.NSBundle bundle)
```
    Retrieves a given string for a given name, extension and bundle.
    
    Parameters:
    
    name - of the resource
    
    extension - of the resource, example: txt or rtf
    
    bundle - to look for the resource in
    
    Returns:
    
    string of the given file specified in the bundle
  - firstPropertyKeyInKeyPath
```
public static final String firstPropertyKeyInKeyPath(String keyPath)
```
  - lastPropertyKeyInKeyPath
```
public static final String lastPropertyKeyInKeyPath(String keyPath)
```
  - keyPathWithoutLastProperty
```
public static final String keyPathWithoutLastProperty(String keyPath)
```
  - keyPathWithoutFirstProperty
```
public static final String keyPathWithoutFirstProperty(String keyPath)
```
  - displayNameForKey
```
public static String displayNameForKey(String key)
```
    Calculates a default display name for a given key path. For instance for the key path: "foo.bar" the display name would be "Bar".
    
    Parameters:
    
    key - to calculate the display name
    
    Returns:
    
    display name for the given key
  - indexOfNumericInString
```
public static int indexOfNumericInString(String str)
```
    Locate the the first numeric character in the given string.
    
    Parameters:
    
    str - string to scan
    
    Returns:
    
    position in string or -1 if no numeric found
  - indexOfNumericInString
```
public static int indexOfNumericInString(String str,
                                         int fromIndex)
```
    Locate the the first numeric character after fromIndex in the given string.
    
    Parameters:
    
    str - string to scan
    
    fromIndex - index position from where to start
    
    Returns:
    
    position in string or -1 if no numeric found
  - appendSeparatorIfLastNot
```
public static void appendSeparatorIfLastNot(char separator,
                                            char not,
                                            StringBuffer sb)
```
    Utility method to append a character to a StringBuffer if the last character is not a certain character. Useful for determining if you need to add an '&' to the end of a form value string.
    
    Parameters:
    
    separator - character to potentially add to the StringBuffer.
    
    not - character to test if the given StringBuffer ends in it.
    
    sb - StringBuffer to test and potentially append to.
  - appendSeparatorIfLastNot
```
public static void appendSeparatorIfLastNot(char separator,
                                            char not,
                                            StringBuilder sb)
```
    Utility method to append a character to a StringBuilder if the last character is not a certain character. Useful for determining if you need to add an '&' to the end of a form value string.
    
    Parameters:
    
    separator - character to potentially add to the StringBuilder.
    
    not - character to test if the given StringBuilder ends in it.
    
    sb - StringBuilder to test and potentially append to.
  - removeSpaces
```
public static String removeSpaces(String aString)
```
    Removes the spaces in a given string.
    
    Parameters:
    
    aString - string to remove spaces from
    
    Returns:
    
    string without spaces
  - toLowerCase
```
public static String toLowerCase(String str)
```
    This method runs about 20 times faster than java.lang.String.toLowerCase (and doesn't waste any storage when the result is equal to the input). Warning: Don't use this method when your default locale is Turkey. java.lang.String.toLowerCase is slow because (a) it uses a StringBuffer (which has synchronized methods), (b) it initializes the StringBuffer to the default size, and (c) it gets the default locale every time to test for name equal to "tr".
    
    See Also:
    
    tolower
    
    Author:
    
    Peter Norvig
  - stringWithNtimesString
```
public static String stringWithNtimesString(int n,
                                            String s)
```
    String multiplication.
    
    Parameters:
    
    n - the number of times to concatenate a given string
    
    s - string to be multiplied
    
    Returns:
    
    multiplied string
  - numberOfOccurrencesOfCharInString
```
public static int numberOfOccurrencesOfCharInString(char c,
                                                    String s)
```
    Counts the number of occurrences of a particular char in a given string.
    
    Parameters:
    
    c - char to count in string
    
    s - string to look for specified char in.
    
    Returns:
    
    number of occurrences of a char in the string
  - stringIsNullOrEmpty
```
public static boolean stringIsNullOrEmpty(String s)
```
    Simple test if the string is either null or equal to "".
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    result of the above test
  - nullForEmptyString
```
public static String nullForEmptyString(String s)
```
    Simple utility method that will return null if the string passed in is equal to "" otherwise it will return the passed in string.
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    null if the string is "" else the string.
  - emptyStringForNull
```
public static String emptyStringForNull(String s)
```
    Simple utility method that will return the string "" if the string passed in is null otherwise it will return the passed in string.
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    the empty string if the string is null, else the string
  - escapeNonXMLChars
```
public static String escapeNonXMLChars(String str)
```
  - unescapeEntities
```
public static String unescapeEntities(String string,
                                      Map<String,String> map)
```
    Util to unescape entities. Entities not found in the set will be left intact.
    
    Parameters:
    
    string - string to unescape
    
    map - map of entities
    
    Returns:
    
    unescaped string
  - escapePCData
```
public static String escapePCData(String pcdata)
```
    Escapes the given PCDATA string as CDATA.
    
    Parameters:
    
    pcdata - The string to escape
    
    Returns:
    
    the escaped string
  - escapeNonBasicLatinChars
```
public static String escapeNonBasicLatinChars(char c)
```
  - escapeNonBasicLatinChars
```
public static String escapeNonBasicLatinChars(String str)
```
  - escapeJavascriptApostrophes
```
public static String escapeJavascriptApostrophes(String sourceString)
```
    Escapes the apostrophes in a Javascript string with a backslash.
    
    Parameters:
    
    sourceString - the source string to escape
    
    Returns:
    
    the escaped javascript string
  - escape
```
public static String escape(char[] _escapeChars,
                            char _escapeWith,
                            String _sourceString)
```
    Escapes the given characters with the given escape character in _sourceString. This implementation is specifically designed for large strings. In the event that no characters are escaped, the original string will be returned with no new object creation. A null _sourceString will return null. Example: sourceString = Mike's, escape chars = ', escape with = \, returns Mike\'s
    
    Parameters:
    
    _escapeChars - the list of characters to escape
    
    _escapeWith - the escape character to use
    
    _sourceString - the string to escape the characters in.
    
    Returns:
    
    the escaped string
  - toHexString
```
public static String toHexString(char c)
```
  - toHexString
```
public static String toHexString(String str)
```
  - byteArrayToHexString
```
public static String byteArrayToHexString(byte[] block)
```
    Converts a byte array to hex string.
    
    Parameters:
    
    block - byte array
    
    Returns:
    
    hex string
  - hexStringToByteArray
```
public static byte[] hexStringToByteArray(String hexString)
```
    Converts a even-length, hex-encoded String to a byte array.
    
    Parameters:
    
    hexString - hex string to convert
    
    Returns:
    
    byte array of given hex string
  - removeExtraDotsFromVersionString
```
public static String removeExtraDotsFromVersionString(String version)
```
    Cleans up the given version string by removing extra dots(.), for example, 5.1.3 becomes 5.13, so that the string can be converted to a double or BigDecimal type easily.
    
    Parameters:
    
    version - string
    
    Returns:
    
    cleaned-up string that only contains the first dot(.) as the floating point indicator.
  - capitalize
```
public static String capitalize(String value)
```
    Capitalizes a given string. That is, the first character of the returned string will be upper case, and other characters will be unchanged. For example, for the input string "you have a dog", this method would return "You have a dog".
    
    Parameters:
    
    value - to be capitalized
    
    Returns:
    
    capitalized string
  - uncapitalize
```
public static String uncapitalize(String value)
```
    Uncapitalizes a given string.
    
    Parameters:
    
    value - to be uncapitalized
    
    Returns:
    
    capitalized string
  - capitalizeAllWords
```
public static String capitalizeAllWords(String value)
```
    Capitalizes all the strings in a given string. That is, the first character of each (whitespace-delimited) word in the input string will be upper case, and other characters will be unchanged. Additionally, each region of contiguous whitespace in the original string is converted to a single space in the result. For example, for the input string "you have a dog" (with two spaces between each word), this method would return "You Have A Dog".
    
    Parameters:
    
    value - to be capitalized
    
    Returns:
    
    capitalized string
  - underscoreToCamelCase
```
public static String underscoreToCamelCase(String underscoreString,
                                           boolean capitalize)
```
    Converts this_is_a_test to ThisIsATest
    
    Parameters:
    
    underscoreString - the string_with_underscores
    
    capitalize - if true, the first letter is capitalized
    
    Returns:
    
    the StringWithoutUnderscores
  - camelCaseToUnderscore
```
public static String camelCaseToUnderscore(String camelString,
                                           boolean lowercase)
```
    Converts a string in camel case to an underscore representation.
    
    Parameters:
    
    camelString - string to convert
    
    lowercase - if all uppercase characters should be converted to lowercase
    
    Returns:
    
    the string_with_underscores
  - stringEqualsString
```
public static boolean stringEqualsString(String s1,
                                         String s2)
```
  - caseInsensitiveStartsWith
```
public static boolean caseInsensitiveStartsWith(String stringToSearch,
                                                String prefix)
```
    Tests if the string starts with the specified prefix ignoring case. This method is optimized so that it only converts the relevant substring of stringToSearch to lowercase before comparing it to the lowercase version of prefix.
    
    Parameters:
    
    stringToSearch - string to check
    
    prefix - prefix to look for
    
    Returns:
    
    true if stringToSearch case-insensitively starts with prefix
  - caseInsensitiveStartsWith
```
public static boolean caseInsensitiveStartsWith(String stringToSearch,
                                                String prefix,
                                                int toffset)
```
    Tests if the string starts with the specified prefix starting at the specified index ignoring case. This method is optimized so that it only converts the relevant substring of stringToSearch to lowercase before comparing it to the lowercase version of prefix.
    
    Parameters:
    
    stringToSearch - string to check
    
    prefix - prefix to look for
    
    toffset - starting offset to perform the search
    
    Returns:
    
    true if stringToSearch case-insensitively starts with prefix starting at toffset
  - stringByTruncatingStringToByteLengthInEncoding
```
public static String stringByTruncatingStringToByteLengthInEncoding(String inputString,
                                                                    int byteLength,
                                                                    String encoding)
```
    This method takes a string and returns a string which is the first string such that the result byte length in the specified encoding does not exceed the byte limit. This tends to be an issue with UTF-8 and Japanese characters because they're double- or triple-byte in UTF-8 and you need to be careful not to split in the middle of a multi-byte sequence.
    This method is optimized for the UTF-8 case. If encoding is either "UTF-8" or "UTF8", the optimized case will kick in.
    
    Parameters:
    
    inputString - string to truncate
    
    byteLength - maximum byte length
    
    encoding - encoding to use
    
    Returns:
    
    string truncated appropriately.
  - stringContainsSpecialRegexCharacters
```
public static boolean stringContainsSpecialRegexCharacters(String s)
```
    checks if the String contains a character that has a special meaning in regex. This could used to ensure that username and passwords have no such characters.
    
    Parameters:
    
    s - the string to check
    
    Returns:
    
    true if s contains one or multiple characters that have special meanings in regex.
  - stringFromURL
```
public static String stringFromURL(URL url)
                            throws IOException
```
    Returns a string from the contents of the given URL.
    
    Parameters:
    
    url - the URL to read from
    
    Returns:
    
    the string that was read
    
    Throws:
    
    IOException - if the connection fails
  - stringFromURL
```
public static String stringFromURL(URL url,
                                   String encoding)
                            throws IOException
```
    Returns a string from the contents of the given URL.
    
    Parameters:
    
    url - the URL to read from
    
    encoding - the string encoding to read with
    
    Returns:
    
    the string that was read
    
    Throws:
    
    IOException - if the connection fails
  - stringFromInputStream
```
public static String stringFromInputStream(InputStream in)
                                    throws IOException
```
    Returns a string from the input stream using the default encoding.
    
    Parameters:
    
    in - stream to read
    
    Returns:
    
    string representation of the stream.
    
    Throws:
    
    IOException - if things go wrong
  - stringFromInputStream
```
public static String stringFromInputStream(InputStream in,
                                           String encoding)
                                    throws IOException
```
    Returns a string from the input stream using the default encoding.
    
    Parameters:
    
    in - stream to read
    
    encoding - to be used, null will use the default
    
    Returns:
    
    string representation of the stream.
    
    Throws:
    
    IOException - if things go wrong
  - toString
```
public static String toString(Object[] array,
                              String separator)
```
    Returns a String by invoking toString() on each object from the array. After each toString() call the separator is appended to the buffer.
    
    Parameters:
    
    array - an object array from which to get a nice String representation
    
    separator - a separator which is displayed between the objects toString() value
    
    Returns:
    
    a string representation from the array
  - dumpObject
```
public static String dumpObject(Object object)
```
    Creates a readable debug string for some data types (dicts, arrays, adaptorOperations, databaseOperations).
    
    Parameters:
    
    object - the object to dump
    
    Returns:
    
    string representation of the given object
  - containsAnyCharacter
```
public static boolean containsAnyCharacter(String source,
                                           String characters)
```
    Checks if any of the characters specified in characters is contained in the string specified by source.
    
    Parameters:
    
    source - the String which might contain characters
    
    characters - the characters to check
    
    Returns:
    
    true if any character from characters is in source, false otherwise
  - removeExceptCharacters
```
public static String removeExceptCharacters(String source,
                                            String characters)
```
    Removes any character which is not in characters from the source string.
    
    Parameters:
    
    source - the string which will be modified
    
    characters - the characters that are allowed to be in source
    
    Returns:
    
    a new string only with characters from the characters argument
  - removeCharacters
```
public static String removeCharacters(String source,
                                      String characters)
```
    Removes any character which is in characters from the source string.
    
    Parameters:
    
    source - the string which will be modified
    
    characters - the characters that are not allowed to be in source
    
    Returns:
    
    a new string without any characters from the characters argument
  - quicksilverContains
```
public static boolean quicksilverContains(String _str,
                                          String _searchString)
```
    Matches strings like Quicksilver (NullPointerException is matched by "NPE"). The rule is basically just that all the letters of the search string must appear in the original string in the same order as the search string, but they are not required to be contiguous or case-matched.
    
    Parameters:
    
    _str - the string to search in
    
    _searchString - the search string to look for
    
    Returns:
    
    whether or not _str contains _searchString
  - md5
```
public static byte[] md5(String str,
                         String encoding)
```
    Generate an MD5 hash from a String.
    
    Parameters:
    
    str - the string to hash
    
    encoding - MD5 operates on byte arrays, so we need to know the encoding to getBytes as
    
    Returns:
    
    the MD5 sum of the bytes
  - md5Hex
```
public static String md5Hex(String str,
                            String encoding)
```
    Generate an MD5 hash as hex from a String.
    
    Parameters:
    
    str - the string to hash
    
    encoding - MD5 operates on byte arrays, so we need to know the encoding to getBytes as
    
    Returns:
    
    the MD5 sum of the bytes in a hex string
  - matchCase
```
public static String matchCase(String originalString,
                               String newString)
```
    Returns a string case-matched against the original string. For instance, if originalString is "Mike" and newString is "john", this returns "John". If originalString is "HTTP" and newString is "something", this returns "SOMETHING".
    
    Parameters:
    
    originalString - the original string to analyze the case of
    
    newString - the new string
    
    Returns:
    
    the case-matched variant of newString
  - indent
```
public static void indent(PrintWriter writer,
                          int level)
```
  - indent
```
public static void indent(StringBuffer sb,
                          int level)
```
  - getSimpleClassName
```
public static String getSimpleClassName(Class clazz)
```
    "Borrowed" from 1.5's Class.getSimpleClassName
  - stringFromDictionary
```
public static String stringFromDictionary(NSDictionary dict)
```
    Same as NSPropertySerialization except it sorts on keys first.
    
    Parameters:
    
    dict -
  - regionMatches
```
public static boolean regionMatches(StringBuffer str,
                                    int toffset,
                                    String other,
                                    int ooffset,
                                    int len)
```
    It's ridiculous that StringBuffer doesn't have a .regionMatches like String. This is stolen from String and re-implemented on top of StringBuffer. It's slightly slower than String's because we have to call charAt instead of just accessing the underlying array, but so be it.
    
    Parameters:
    
    str - the StringBuffer to compare a region of
    
    toffset - the starting offset of the sub-region in this string.
    
    other - the string argument.
    
    ooffset - the starting offset of the sub-region in the string argument.
    
    len - the number of characters to compare.
    
    Returns:
    
    true if the specified sub-region of this string exactly matches the specified sub-region of the string argument; false otherwise.
  - safeIdentifierName
```
public static String safeIdentifierName(String source,
                                        String prefix,
                                        char replacement)
```
    Converts source to be suitable for use as an identifier in JavaScript. prefix is prefixed to source if the first character of source is not suitable to start an identifier (e.g. a number). Any characters in source that are not allowed in an identifier are replaced with replacement.
    
    Parameters:
    
    source - String to make into a identifier name
    
    prefix - String to prefix source with to make it a valid identifier name
    
    replacement - character to use to replace characters in source that are no allowed in an identifier name
    
    Returns:
    
    source converted to a name suitable for use as an identifier in JavaScript
    
    See Also:
    
    Character.isJavaIdentifierStart(char), Character.isJavaIdentifierPart(char)
  - safeIdentifierName
```
public static String safeIdentifierName(String source,
                                        String prefix)
```
    Convenience method to call safeIdentifierName(source, prefix, '_')
    
    Parameters:
    
    source - String to make into a identifier name
    
    prefix - String to prefix source with to make it a valid identifier name
    
    Returns:
    
    source converted to a name suitable for use as an identifier in JavaScript
    
    See Also:
    
    safeIdentifierName(String, String, char)
  - safeIdentifierName
```
public static String safeIdentifierName(String source)
```
    Convenience method to call safeIdentifierName(source, "_", '_')
    
    Parameters:
    
    source - String to make into a identifier name
    
    Returns:
    
    source converted to a name suitable for use as an identifier in JavaScript
    
    See Also:
    
    safeIdentifierName(String, String, char)
  - urlEncode
```
public static String urlEncode(String string)
```
    Utility to encode an URL without the try/catch. Throws an NSForwardException in the unlikely case that ERXMessageEncoding.defaultEncoding() can't be found.
    
    Parameters:
    
    string -
  - urlDecode
```
public static String urlDecode(String string)
```
    Utility to decode an URL without the try/catch. Throws an NSForwardException in the unlikely case that ERXMessageEncoding.defaultEncoding() can't be found.
    
    Parameters:
    
    string -
  - toUTF8Bytes
```
public static byte[] toUTF8Bytes(String string)
```
    Utility to convert to UTF-8 bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found.
    
    Parameters:
    
    string - string to convert
  - toBytes
```
public static byte[] toBytes(String string,
                             String encoding)
```
    Utility to convert to bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found.
    
    Parameters:
    
    string - string to convert
    
    encoding -
  - fromUTF8Bytes
```
public static String fromUTF8Bytes(byte[] bytes)
```
    Utility to convert from UTF-8 bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found.
    
    Parameters:
    
    bytes - string to convert
  - fromBytes
```
public static String fromBytes(byte[] bytes,
                               String encoding)
```
    Utility to convert from bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found.
    
    Parameters:
    
    bytes - string to convert
    
    encoding -
  - rightPad
```
public static String rightPad(String string,
                              char padChar,
                              int paddedLength)
```
    Pads a string to the specified number of chars by adding the the given pad char on the right side. If the string is longer than paddedLength, it is returned unchanged.
    
    Parameters:
    
    string - the string to pad
    
    padChar - the character to pad with
    
    paddedLength - the length to pad to
    
    Returns:
    
    the padded string
  - leftPad
```
public static String leftPad(String string,
                             char padChar,
                             int paddedLength)
```
    Pads a string to the specified number of chars by adding the the given pad char on the left side. If the string is longer than paddedLength, it is returned unchanged.
    
    Parameters:
    
    string - the string to pad
    
    padChar - the character to pad with
    
    paddedLength - the length to pad to
    
    Returns:
    
    the padded string
  - insertString
```
public static String insertString(String destinationString,
                                  String contentToInsert,
                                  int insertOffset)
```
    Inserts the a string into another string at a particular offset.
    
    Parameters:
    
    destinationString - the string to insert into
    
    contentToInsert - the string to insert
    
    insertOffset - the offset in destinationString to insert
    
    Returns:
    
    the resulting string
  - trimString
```
public static String trimString(String s)
```
    Null-safe wrapper for java.lang.String.trim
    
    Parameters:
    
    s - string to trim
    
    Returns:
    
    trimmed string or null if s was null
  - excelSafeCsvString
```
public static String excelSafeCsvString(String s)
```
    Removes line breaks and quotes the string if necessary
    
    Parameters:
    
    s -
    
    Returns:
    
    the string in Excel save CSV format
  - unquote
```
public static String unquote(String s,
                             String quoteSymbol)
```
    Remove the quote symbols from the given string
    
    Parameters:
    
    s -
    
    quoteSymbol -
    
    Returns:
    
    the string unquoted
  - quote
```
public static String quote(String s,
                           String quoteSymbol)
```
    Quote the given string with the provided quote symbols
    
    Parameters:
    
    s - the string to quote
    
    quoteSymbol - - the quote symbol
    
    Returns:
    
    quoted string
  - stringByAppendingCSSClass
```
public static String stringByAppendingCSSClass(String originalString,
                                               String cssClass)
```
    Appends a CSS class to an existing (possibly null) CSS class string.
    
    Parameters:
    
    originalString - the original string
    
    cssClass - the new CSS class to append
    
    Returns:
    
    the CSS classes appended together (with a space between if originalString is non-empty)
  - stripHtml
```
public static String stripHtml(String str,
                               boolean convertChars)
```
    Removes HTML characters from the given string.
    
    Parameters:
    
    str - the string to remove HTML from
    
    convertChars - set to true if you want html special chars to be converted ( ex. © to (C) ), false otherwise
    
    Returns:
    
    the string without HTML characters in it
  - removeHTMLTagsFromString
```
public static String removeHTMLTagsFromString(String s)
```
    Removes all of the HTML tags from a given string. Note: this is a very simplistic implementation and will most likely not work with complex HTML. Note: for actual conversion of HTML tags into regular strings have a look at ERXSimpleHTMLFormatter
    
    Parameters:
    
    s - html string
    
    Returns:
    
    string with all of its html tags removed
  - strippedValue
```
public static String strippedValue(String value,
                                   int length)
```
    Returns the value stripped from HTML tags if escapeHTML is false. This makes sense because it is not terribly useful to have half-finished tags in your code. Note that the "length" of the resulting string is not very exact. FIXME: we could remove extra whitespace and character entities here
    
    Returns:
    
    value stripped from tags.
  - attributeValueFromString
```
public static Object attributeValueFromString(EOAttribute attr,
                                              String strVal,
                                              String encoding,
                                              Format formatter)
```
    Attempts to convert string values for attributes into the appropriate value class for the attribute. If the method is unable to convert the value, it returns null.
    
    Parameters:
    
    attr - The attribute for the value in question.
    
    strVal - The string value to be coerced.
    
    encoding - The encoding used if the attribute value class is custom and the factory method does not accept a string.
    
    formatter - The formatter used if the value class is NSTimestamp.
    
    Returns:
    
    The coerced object value or null.
  - attributeNumberValueFromString
```
public static Number attributeNumberValueFromString(EOAttribute attr,
                                                    String strVal)
```
    Attempts to convert string values for attributes into the appropriate value class for the attribute. If the method is unable to convert the value, it returns null.
    
    Parameters:
    
    attr - The attribute for the value in question.
    
    strVal - The string value to be coerced.
    
    Returns:
    
    The coerced object value or null.
  - attributeCustomValueFromString
```
public static Object attributeCustomValueFromString(EOAttribute attr,
                                                    String strVal,
                                                    String encoding)
```
    Attempts to convert string values for attributes into the appropriate value class for the attribute. If the method is unable to convert the value, it returns null.
    
    Parameters:
    
    attr - The attribute for the value in question.
    
    strVal - The string value to be coerced.
    
    encoding - The encoding used if the attribute value class is custom and the factory method does not accept a string.
    
    Returns:
    
    The coerced object value or null.
  - isValueInRange
```
public static boolean isValueInRange(int value,
                                     String rangeString)
```
    Returns whether the given value falls in a range defined by the given string, which is in the format "1-5,100,500,800-1000".
    
    Parameters:
    
    value - the value to check for
    
    rangeString - the range string to parse
    
    Returns:
    
    whether or not the value falls within the given ranges
  - maskStringWithCharacter
```
public static String maskStringWithCharacter(String arg,
                                             char mask,
                                             int beginIndex,
                                             int endIndex)
```
    Masks a given string with a single character in the substring specified by the begin and end indexes. Negative indexes count from the end of the string beginning with -1. For example, maskStringWithCharacter("Visa 4111111111111111", '*', 5, -4); will result in a string value of "Visa ************1111"
    
    Parameters:
    
    arg - The string value to mask
    
    mask - The character mask
    
    beginIndex - The string index where masking begins. Negative numbers count down from the end of the string.
    
    endIndex - The index where masking ends. Negative numbers count down from the end of the string
    
    Returns:
    
    The masked string result
  - luhnCheck
```
public static boolean luhnCheck(String value)
```
    A fast Luhn algorithm check. This method only verifies that the string argument validates with the Luhn algorithm. It does not attempt to verify if the number conforms to ISO/IEC 7812 specifications.
    
    Parameters:
    
    value - A string value consisting of numeric digits between 0-9. If the number contains hyphens, spaces, or anything other than a string of digits between 0-9 the method returns false.
    
    Returns:
    
    true if the value passes a luhn check, false otherwise.
  - wordSafeTrimmedString
```
public static String wordSafeTrimmedString(String trimmingString,
                                           int maxLenght)
```
    Returns a string trimmed about at the max length you define without truncating the last word and adding "..." (if necessary)
    
    Parameters:
    
    trimmingString - the string you would like to trim
    
    maxLenght - the max length you need
    
    Returns:
    
    the string trimmed
  - trimZeroInFrontOfNumbers
```
public static String trimZeroInFrontOfNumbers(String str)
```
    trim leading 0 from a (Number) String
    
    Parameters:
    
    str - - the String
    
    str - - 処理対象の文字列
    
    Returns:
    
    Result String 半角数字の前の0を取る処理。
  - cleanString
```
public static String cleanString(String newString,
                                 NSArray<String> toBeCleaneds)
```
    Given an initial string and an array of substrings, Removes any occurrences of any of the substrings from the initial string. Used in conjunction with fuzzy matching.
    
    Parameters:
    
    newString - initial string from which to remove other strings
    
    toBeCleaneds - array of substrings to be removed from the initial string.
    
    Returns:
    
    cleaned string.
  - isBlank
```
public static boolean isBlank(String value)
```
  - isNotBlank
```
public static boolean isNotBlank(String value)
```

Class ERXStringUtilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEX_CHARS

SORT_ASCENDING

SORT_DESCENDING

SpecialRegexCharacters

adjustement

XML_UNESCAPES

ISO_UNESCAPES

SYMBOL_UNESCAPES

HTML_SAFE_UNESCAPES

HTML_UNESCAPES

Constructor Detail

ERXStringUtilities

Method Detail

setAdjustement

fuzzyMatch

localizedStringForKey

localizedStringForKey

localizedStringForKey

localizedTemplateStringWithObjectForKey

stringWithContentsOfFile

stringWithContentsOfFile

integerWithString

stringIsParseableInteger

safeInteger

safeLong

stringFromResource

firstPropertyKeyInKeyPath

lastPropertyKeyInKeyPath

keyPathWithoutLastProperty

keyPathWithoutFirstProperty

displayNameForKey

indexOfNumericInString

indexOfNumericInString

appendSeparatorIfLastNot

appendSeparatorIfLastNot

removeSpaces

toLowerCase

stringWithNtimesString

numberOfOccurrencesOfCharInString

stringIsNullOrEmpty

nullForEmptyString

emptyStringForNull

escapeNonXMLChars

unescapeEntities

escapePCData

escapeNonBasicLatinChars

escapeNonBasicLatinChars

escapeJavascriptApostrophes

escape

toHexString

toHexString

byteArrayToHexString

hexStringToByteArray

removeExtraDotsFromVersionString

capitalize

uncapitalize

capitalizeAllWords

underscoreToCamelCase

camelCaseToUnderscore

stringEqualsString

caseInsensitiveStartsWith

caseInsensitiveStartsWith

stringByTruncatingStringToByteLengthInEncoding

stringContainsSpecialRegexCharacters

stringFromURL

stringFromURL

stringFromInputStream

stringFromInputStream

toString

dumpObject

containsAnyCharacter

removeExceptCharacters

removeCharacters

quicksilverContains