|
Project Wonder 5.0.0.8654 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objecter.extensions.foundation.ERXStringUtilities
public class ERXStringUtilities
Collection of String utilities. Contains
the base localization support.
| Field Summary | |
|---|---|
protected static double |
adjustement
holds the base adjustment for fuzzy matching |
static char[] |
HEX_CHARS
Holds the chars for hex enconding |
static NSArray |
SORT_ASCENDING
Holds the ascending EOSortOrderings |
static NSArray |
SORT_DESCENDING
Holds the ascending EOSortOrderings |
static String |
SpecialRegexCharacters
Holds characters that have special meaning for regex |
| Constructor Summary | |
|---|---|
ERXStringUtilities()
|
|
| Method Summary | |
|---|---|
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 String |
byteArrayToHexString(byte[] block)
Converts a byte array to hex string. |
static String |
camelCaseToUnderscore(String camelString,
boolean lowercase)
Converts ThisIsATest to this_is_a_test |
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 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 double |
distance(String a,
String b)
Java port of the distance algorithm. |
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 |
escapeNonBasicLatinChars(char c)
|
static String |
escapeNonBasicLatinChars(String str)
|
static String |
escapeNonXMLChars(String str)
|
static String |
escapeSpace(String aString)
Removes the spaces in a given String |
static String |
excelSafeCsvString(String s)
Removes line breaks and quotes the string if neccessary |
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,
EOEditingContext ec,
ERXFuzzyMatchCleaner cleaner,
NSArray sortOrderings)
Fuzzy matching is useful for catching user entered typos. |
static NSArray |
fuzzyMatch(String name,
String entityName,
String propertyKey,
String synonymsKey,
EOEditingContext ec,
ERXFuzzyMatchCleaner cleaner,
String comparisonString)
Deprecated. use fuzzyMatch(String name, String entityName, String propertyKey,
String synonymsKey, EOEditingContext ec,
ERXFuzzyMatchCleaner cleaner, NSArray sortOrderings )
instead |
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 a nother string at a particular offset. |
static Integer |
integerWithString(String s)
Calculates an Integer for a given string. |
static boolean |
isDigitsOnly(String aString)
checks if the specified String contains only digits. |
static boolean |
isLettersOnly(String aString)
checks if the specified String contains only Letters. |
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 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 |
replaceStringByStringInString(String old,
String newString,
String buffer)
Replaces a given string by another string in a 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 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 |
stringByReplacingFirstOccurrenceOfStringWithString(String sourceString,
String stringToReplace,
String replacementString)
Replaces the first occurrence of a string with another string in a 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,
NSBundle bundle)
Retrives 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 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)
Removes HTML characters from the given string. |
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 |
uncapitalize(String value)
Uncapitalizes a given string. |
static String |
underscoreToCamelCase(String underscoreString,
boolean capitalize)
Converts this_is_a_test to ThisIsATest |
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final char[] HEX_CHARS
public static final NSArray SORT_ASCENDING
EOSortOrderings
public static final NSArray SORT_DESCENDING
EOSortOrderings
public static final String SpecialRegexCharacters
protected static double adjustement
| Constructor Detail |
|---|
public ERXStringUtilities()
| Method Detail |
|---|
public static double distance(String a,
String b)
a - first stringb - second string
public static void setAdjustement(double newAdjustement)
newAdjustement - factor to be used.
public static NSArray fuzzyMatch(String name,
String entityName,
String propertyKey,
String synonymsKey,
EOEditingContext ec,
ERXFuzzyMatchCleaner cleaner,
NSArray sortOrderings)
name - to be matched againstentityName - name of the entity to perform the match against.propertyKey - to be matched againstsynonymsKey - allows objects to have additional values to be matched
against in addition to just the value of the propertyKeyec - context to fetch data incleaner - 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.
public static NSArray fuzzyMatch(String name,
String entityName,
String propertyKey,
String synonymsKey,
EOEditingContext ec,
ERXFuzzyMatchCleaner cleaner,
String comparisonString)
fuzzyMatch(String name, String entityName, String propertyKey,
String synonymsKey, EOEditingContext ec,
ERXFuzzyMatchCleaner cleaner, NSArray sortOrderings )
instead
public static String localizedStringForKey(String key)
key - to be lookup in the strings file
public static String localizedStringForKey(String key,
String framework)
key - to be lookup in the strings fileframework - name, specify app or null to perform the
lookup in the application's resources.
public static String localizedStringForKey(String key,
String framework,
NSArray languages)
key - to be lookup in the strings fileframework - name, specify app or null to perform the
lookup in the application's resources.languages - array to search for the key in
public static String localizedTemplateStringWithObjectForKey(Object o,
String key,
String framework,
NSArray languages)
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.
o - object used to resolve keys in the localized templatekey - to be lookup in the strings fileframework - name, specify app or null to perform the
lookup in the application's resources.languages - array to search for the key in
public static String stringWithContentsOfFile(File file)
file - path to the file in the file system
public static String stringWithContentsOfFile(String path)
path - to the file in the file system
public static Integer integerWithString(String s)
s - string to caclulate an Integer from
ERXConstant#integerForString(String)
public static String stringFromResource(String name,
String extension,
NSBundle bundle)
name - of the resourceextension - of the resource, example: txt or rtfbundle - to look for the resource in
public static final String firstPropertyKeyInKeyPath(String keyPath)
public static final String lastPropertyKeyInKeyPath(String keyPath)
public static final String keyPathWithoutLastProperty(String keyPath)
public static final String keyPathWithoutFirstProperty(String keyPath)
public static String displayNameForKey(String key)
key - to calculate the display name
public static int indexOfNumericInString(String str)
str - string to scan
public static int indexOfNumericInString(String str,
int fromIndex)
fromIndex in the given string.
str - string to scan
public static void appendSeparatorIfLastNot(char separator,
char not,
StringBuffer sb)
separator - character to add 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.
public static String replaceStringByStringInString(String old,
String newString,
String buffer)
old - string to be replacednewString - to be insertedbuffer - string to have the replacement done on it
public static String stringByReplacingFirstOccurrenceOfStringWithString(String sourceString,
String stringToReplace,
String replacementString)
sourceString - string to use on which to perform the replacementstringToReplace - string to replace in sourceString if it exists.replacementString - the string with which to replace stringToReplace.
public static String escapeSpace(String aString)
public static String toLowerCase(String str)
public static String stringWithNtimesString(int n,
String s)
n - the number of times to concatinate a given strings - string to be multipled
public static int numberOfOccurrencesOfCharInString(char c,
String s)
char in a given string.
c - char to count in strings - string to look for specified char in.
public static boolean stringIsNullOrEmpty(String s)
s - string to test
public static String nullForEmptyString(String s)
s - string to test
public static String emptyStringForNull(String s)
s - string to test
public static String escapeNonXMLChars(String str)
public static String escapeNonBasicLatinChars(char c)
public static String escapeNonBasicLatinChars(String str)
public static String escape(char[] _escapeChars,
char _escapeWith,
String _sourceString)
_escapeChars - the list of characters to escape_escapeWith - the escape character to use_sourceString - the string to escape the characters in.
public static String toHexString(char c)
public static String toHexString(String str)
public static String byteArrayToHexString(byte[] block)
block - byte array
public static byte[] hexStringToByteArray(String hexString)
hexString - public static String removeExtraDotsFromVersionString(String version)
version - string
public static String capitalize(String value)
value - to be capitalized
public static String uncapitalize(String value)
value - to be uncapitalized
public static String capitalizeAllWords(String value)
value - to be capitalized
public static String underscoreToCamelCase(String underscoreString,
boolean capitalize)
underscoreString - the string_with_underscorescapitalize - if true, the first letter is capitalized
public static String camelCaseToUnderscore(String camelString,
boolean lowercase)
camelString - the StringWithCaps
public static boolean stringEqualsString(String s1,
String s2)
public static boolean caseInsensitiveStartsWith(String stringToSearch,
String prefix)
stringToSearch - string to checkprefix - prefix to look for
public static boolean caseInsensitiveStartsWith(String stringToSearch,
String prefix,
int toffset)
stringToSearch - string to checkprefix - prefix to look fortoffset - starting offset to perform the search
public static String stringByTruncatingStringToByteLengthInEncoding(String inputString,
int byteLength,
String encoding)
This method is optimized for the UTF-8 case. If encoding is either "UTF-8" or "UTF8",
the optimized case will kick in.
inputString - string to truncatebyteLength - maximum byte lengthencoding - encoding to use
public static boolean isDigitsOnly(String aString)
aString - the string to check
public static boolean isLettersOnly(String aString)
aString - the string to check
public static boolean stringContainsSpecialRegexCharacters(String s)
s - the string to check
true if s contains one or multiple characters that have special
meanings in regex.
public static String stringFromURL(URL url)
throws IOException
url - the URL to read from
IOException - if the connection fails
public static String stringFromURL(URL url,
String encoding)
throws IOException
url - the URL to read fromencoding - the string encoding to read with
IOException - if the connection fails
public static String stringFromInputStream(InputStream in)
throws IOException
in - stream to read
IOException
public static String stringFromInputStream(InputStream in,
String encoding)
throws IOException
in - stream to readencoding - to be used, null will use the default
IOException
public static String toString(Object[] array,
String separator)
array - an object array from which to get a nice String representationseparator - a separator which is displayed between the objects toString() value
public static String dumpObject(Object object)
public static boolean containsAnyCharacter(String source,
String characters)
source - the String which might contain characterscharacters - the characters to check
public static String removeExceptCharacters(String source,
String characters)
source - the string which will be modifiedcharacters - the characters that are allowed to be in source
public static String removeCharacters(String source,
String characters)
source - the string which will be modifiedcharacters - the characters that are not allowed to be in source
public static boolean quicksilverContains(String _str,
String _searchString)