Strings (j(s)-lib Commons 1.1.2 API)

java.lang.Object
- js.util.Strings

```
public class Strings
extends Object
```
Strings manipulation utility. This utility class allows for sub-classing. See js.util for utility sub-classing description.

Version:

final

Author:

Iulian Rotaru

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Strings.PlainTextState` States enumeration for plain text parser automata.
`private static class`	`Strings.State` State machine for numeric value parser.

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`ANY_REX` Regular expression for any character.
`private static char`	`DECIMAL_SEPARATOR` Current locale decimal separator.
`private static char[]`	`DEFAULT_SEPARATORS` Default separators used when `isSeparator(char, char...)` separators list is empty.
`private static String`	`DOT_REX` Regular expression for dot.
`private static char`	`GROUPING_SEPARATOR` Current locale grouping separator.
`private static char[]`	`HEXA` Hexadecimal characters, lower case.
`private static DateFormat`	`ISO_DATE_FORMAT` ISO8601 date format for `toISO(Date)`.
`private static Log`	`log` Class logger.
`private static Pattern`	`MEMBER_NAME_PATTERN` Pattern constant used for Java member name validation.
`private static String[]`	`PASSWORD_DICTIONARY` Password dictionary contains ASCII characters for lower case, upper case, numeric and punctuation.
`private static Pattern`	`QUALIFIED_CLASS_NAME` Pattern for qualified class name.
`private static String`	`REGEXP_PATTERN` Pattern for regular expression reserved characters.
`private static String`	`REPLACE_ARG_REX` First argument for regular expression string replacement.
`private static String`	`SEPARATORS` Standard word separator.
`private static Pattern`	`VARIABLE_PATTERN` String variable pattern used to inject system properties.
`private static String`	`WHITE_SPACES` Escaped white spaces.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Strings()
Prevent default constructor synthesis but allow sub-classing.

Constructors
Modifier	Constructor and Description
`protected`	`Strings()` Prevent default constructor synthesis but allow sub-classing.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`concat(Object... objects)` Concatenates a variable number of objects, as strings.
`static String`	`escapeFilesPattern(String filesPattern)` Escape files pattern for usage with Java regular expressions.
`static String`	`escapeRegExp(String string)` Escape string for regular expression reserved characters.
`static String`	`escapeXML(String text)` Escape text for reserved XML characters.
`static void`	`escapeXML(String text, Writer writer)` Escape text for reserved XML characters to a specified writer.
`static String`	`firstSentence(String text)` Return the first sentence of a string, where a sentence ends with a sentence separator followed be white space.
`static String`	`firstWord(String sentence)` Return first word from a sentence.
`static String`	`format(String format, Object... args)` Process formatted string with arguments transform and no illegal format exception.
`static String`	`generatePassword(int length)` Generate random password of requested length.
`static String`	`getMethodAccessor(String prefix, String memberName)` Get Java accessor for a given member name.
`static String`	`getProtocol(String url)` Get URL protocol or null if given URL does not contains one.
`static int`	`indexOneOf(CharSequence string, char... chars)` Search string index of the first character from a series.
`static String`	`injectProperties(String string)` Inject system properties into text with variables.
`static String`	`injectVariables(String template, Map<String,String> variables)` Inject string values into variables from a given template string.
`static boolean`	`isInteger(String string)` Test if string is an integer numeric value.
`static boolean`	`isMemberName(String name)` Test if given name is Java member like name.
`static boolean`	`isNumeric(String string)` Test if string is a numeric value.
`private static boolean`	`isNumericSuffix(char c)` Predicate to test if character is numeric value suffix.
`static boolean`	`isQualifiedClassName(String name)` Predicate to test if name is qualified name.
`private static boolean`	`isSeparator(char character, char... separators)` Test if `character` is a separator as defined by given `separators` list.
`static String`	`join(Iterable<?> objects)` Join collection of objects, converted to string, using space as separator.
`static String`	`join(Iterable<?> objects, char separator)` Join collection of objects, converted to string, using specified char separator.
`static String`	`join(Iterable<?> objects, String separator)` Join collection of objects, converted to string, using specified string separator.Concatenates strings from collection converted to string but take care to avoid null items.
`static String`	`join(Object[] objects)` Join array of objects, converted to string, using space as separator.
`static String`	`join(Object[] objects, char separator)` Join array of objects, converted to string, using specified separator.
`static String`	`join(Object[] objects, String separator)` Join array of objects, converted to string, using specified specified separator.
`static String`	`last(String string, char separator)` Get last string sequence following given character.
`static String`	`load(File file, Integer... maxCount)` Load string from UTF-8 file content.
`static String`	`load(InputStream inputStream, Integer... maxCount)` Load string from UTF-8 bytes stream then closes it.
`static String`	`load(Reader reader, Integer... maxCount)` Load string from character stream then closes it.
`static String`	`md5(String text)` Generate text MD5 hash into hexadecimal format.
`private static Pair`	`pair(String string, char separator)` Split string value using given separator and return initialized pair instance.
`static String`	`removeFirstWord(String sentence)` Remove first word from a sentence.
`static String`	`removeTrailing(String string, char c)` Remove trailing character, if exists.
`static String`	`replaceAll(String source, Pattern pattern, Handler<String,String> handler)` Replace all pattern occurrences using match transformer.
`static void`	`save(CharSequence chars, File file)` Create target file and copy characters into.
`static void`	`save(CharSequence chars, OutputStream outputStream)` Copy source characters to requested output bytes stream.
`static void`	`save(CharSequence chars, Writer writer)` Copy source characters to requested output characters stream.
`static String`	`setPrefix(String text, String prefix)` Ensure a given text start with requested prefix.
`static List<String>`	`split(String string, char... separators)` Splits string into not empty, trimmed items, using specified separator(s) or space if no separator provided.
`static List<String>`	`split(String string, String separator)` Splits string using specified string separator and returns trimmed values.
`static List<Pair>`	`splitPairs(String string, char pairsSeparator, char componentsSeparator)` Split string using given pairs separator and every pair using pair component separator.
`static String`	`toCamelCase(String word)` Convert word to camel case.
`static String`	`toDashCase(String memberName)` Convert Java member name to list of lower case words separated by dash, that is, HTML and CSS name convention.
`static String`	`toISO(Date date)` Format date to ISO8601.
`static String`	`toMemberName(String words)` Convert dash separated words to Java class member name.
`static String`	`toPlainText(String text)` Deprecated.
`static String`	`toPlainText(String text, int offset, int capacity)` Deprecated.
`static String`	`toString(Object... objects)` Concatenates variable number of objects converted to string, separated by colon.
`private static String`	`toString(Object object)` Convert object to string representation.
`static String`	`toTitleCase(String string)` Convert words separated by dash, underscore, space, slash and backslash to title case.
`static String`	`trim(String string)` Trim white spaces around given string.
`static String`	`trim(String string, char garbage)` Trim given string.
`static String`	`UUID()` Get universal unique ID.

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

- Field Detail
 - log
```
private static final Log log
```
 Class logger.
 - ISO_DATE_FORMAT
```
private static DateFormat ISO_DATE_FORMAT
```
 ISO8601 date format for toISO(Date).
 - QUALIFIED_CLASS_NAME
```
private static final Pattern QUALIFIED_CLASS_NAME
```
 Pattern for qualified class name. This pattern matches class names but without member; inner classes are accepted.
```
 qualifiedClassName := packageName ("." className)+
 packageName := packageName "." packagePart
 packagePart := lowerChar+
 className := upperChar char*
 
```
 - MEMBER_NAME_PATTERN
```
private static final Pattern MEMBER_NAME_PATTERN
```
 Pattern constant used for Java member name validation.
 - DEFAULT_SEPARATORS
```
private static final char[] DEFAULT_SEPARATORS
```
 Default separators used when isSeparator(char, char...) separators list is empty.
 - DECIMAL_SEPARATOR
```
private static final char DECIMAL_SEPARATOR
```
 Current locale decimal separator.
 - GROUPING_SEPARATOR
```
private static final char GROUPING_SEPARATOR
```
 Current locale grouping separator.
 - REGEXP_PATTERN
```
private static final String REGEXP_PATTERN
```
 Pattern for regular expression reserved characters.
 
 See Also:
 
 Constant Field Values
 - REPLACE_ARG_REX
```
private static final String REPLACE_ARG_REX
```
 First argument for regular expression string replacement.
 
 See Also:
 
 Constant Field Values
 - DOT_REX
```
private static final String DOT_REX
```
 Regular expression for dot.
 
 See Also:
 
 Constant Field Values
 - ANY_REX
```
private static final String ANY_REX
```
 Regular expression for any character.
 
 See Also:
 
 Constant Field Values
 - WHITE_SPACES
```
private static final String WHITE_SPACES
```
 Escaped white spaces. This include standard white spaces, dot, comma, colon and semicolon.
 
 See Also:
 
 Constant Field Values
 - SEPARATORS
```
private static final String SEPARATORS
```
 Standard word separator.
 
 See Also:
 
 Constant Field Values
 - VARIABLE_PATTERN
```
private static final Pattern VARIABLE_PATTERN
```
 String variable pattern used to inject system properties.
 - PASSWORD_DICTIONARY
```
private static String[] PASSWORD_DICTIONARY
```
 Password dictionary contains ASCII characters for lower case, upper case, numeric and punctuation.
 - HEXA
```
private static final char[] HEXA
```
 Hexadecimal characters, lower case.
- Constructor Detail
 - Strings
```
protected Strings()
```
 Prevent default constructor synthesis but allow sub-classing.
- Method Detail
 - toCamelCase
```
public static String toCamelCase(String word)
```
 Convert word to camel case. This method convert a single word to English convention title case, that is, first letter to upper case and the rest to lower. Note that this method may have not reasonable results if more words, perhaps space separated, are given; it simply convert all but the first to lower case. Use toMemberName(String) or toTitleCase(String) if need to convert more words.
 Returns null if word argument is null and empty if empty.
 
 Parameters:
 
 word - word to convert.
 
 Returns:
 
 given word as title case, null or empty string.
 - toTitleCase
```
public static String toTitleCase(String string)
```
 Convert words separated by dash, underscore, space, slash and backslash to title case. Title case follows English convention: uses space for separator and every word begin with upper case. Returns null or empty string if given string parameter is null, respective empty.
 
 Parameters:
 
 string - string containing words to convert.
 
 Returns:
 
 string converted to title case, null or empty.
 - toMemberName
```
public static String toMemberName(String words)
```
 Convert dash separated words to Java class member name. Note that first character of returned member name is lower case, e.g. this-is-a-string is converted to thisIsAString.
 Returns null if words argument is null and empty if empty.
 
 Parameters:
 
 words - string to convert.
 
 Returns:
 
 camel case member name.
 - toDashCase
```
public static String toDashCase(String memberName)
```
 Convert Java member name to list of lower case words separated by dash, that is, HTML and CSS name convention.
 Returns null if member name argument is null and empty if empty.
 
 Parameters:
 
 memberName - Java style, camel case member name.
 
 Returns:
 
 dashed string.
 - toISO
```
public static String toISO(Date date)
```
 Format date to ISO8601. Date is normalized to UTC.
 
 Parameters:
 
 date - date to format.
 
 Returns:
 
 date as ISO8601 string.
 - toString
```
public static String toString(Object... objects)
```
 Concatenates variable number of objects converted to string, separated by colon. Return empty string if this method is invoked with no arguments at all. Note that this method uses private helper toString(Object) to actually convert every given object to string.
 
 Parameters:
 
 objects - variable number of objects.
 
 Returns:
 
 objects string representation.
 - toString
```
private static String toString(Object object)
```
 Convert object to string representation. This method applies next heuristic to convert given object to string representation:
 - if object is null returns "null",
 - if it is a String returns it as it is,
 - if is an instance of Class returns Class.getName(),
 - if is an instance of Throwable returns causes trace - limited to 8, from cause to cause; if no cause at all returns Throwable.toString(),
 - if none of above returns Object.toString().
 Parameters:
 
 object - object to stringify.
 
 Returns:
 
 object string representation.
 - toPlainText
```
@Deprecated
public static String toPlainText(String text)
```
 Deprecated.
 
 Convenient variant for toPlainText(String, int, int) when using entire source text.
 
 Parameters:
 
 text - HTML formatted text.
 
 Returns:
 
 newly created plain text.
 - toPlainText
```
@Deprecated
public static String toPlainText(String text,
 int offset,
 int capacity)
```
 Deprecated.
 
 Convert HTML formatted into plain text. This method parses source text and detect HTML tags. Current implementation handle only tags replacing them with line break.
 Implementation note: experimental implementation. This implementation is work in progress and is marked as deprecated to warn developer about logic evolution. Final parser should handle to line break, to double line breaks, <q> to simple quotation mark, <ul> to new lines beginning with tab and dash, <ol> to new lines beginning with tab and ordinal and all <h> tags to triple line breaks.
 
 Parameters:
 
 text - HTML formatted source text,
 
 offset - source text offset,
 
 capacity - generated plain text maximum allowed length.
 
 Returns:
 
 newly created plain text.
 - getMethodAccessor
```
public static String getMethodAccessor(String prefix,
 String memberName)
 throws IllegalArgumentException
```
 Get Java accessor for a given member name. Returns the given memberName prefixed by prefix. If memberName is dashed case, that is, contains dash character convert it to camel case. For example getter for email-addresses is getEmailAddresses and for picture is getPicture.
 Accessor prefix is inserted before method name and for flexibility it can be anything. Anyway, ususal values are get, set and is. It is caller responsibility to supply the right prefix.
 
 Parameters:
 
 prefix - accessor prefix,
 
 memberName - member name.
 
 Returns:
 
 member accessor name.
 
 Throws:
 
 IllegalArgumentException - if any given parameter is null or empty.
 - isQualifiedClassName
```
public static boolean isQualifiedClassName(String name)
```
 Predicate to test if name is qualified name.
 
 Parameters:
 
 name - name to test.
 
 Returns:
 
 true if given name is a qualified class name.
 - isMemberName
```
public static boolean isMemberName(String name)
```
 Test if given name is Java member like name. If name is null return false.
 
 Parameters:
 
 name - name to test.
 
 Returns:
 
 true if given name is Java member like name.
 - concat
```
public static String concat(Object... objects)
```
 Concatenates a variable number of objects, as strings. For every given argument, convert it to string using Object.toString() overload and append to concatenated result. If a given argument happens to be null, skip it. Return empty string if this method is invoked with no arguments at all.
 
 Parameters:
 
 objects - variable number of objects.
 
 Returns:
 
 concatenated objects.
 - join
```
public static String join(Object[] objects)
```
 Join array of objects, converted to string, using space as separator. Returns null if given objects array is null and empty if empty. Null objects or empty strings from given objects parameter are ignored.
 
 Parameters:
 
 objects - array of objects to join.
 
 Returns:
 
 joined string.
 - join
```
public static String join(Object[] objects,
 char separator)
```
 Join array of objects, converted to string, using specified separator. Returns null if given objects array is null and empty if empty. Null objects or empty strings from given objects parameter are ignored.
 
 Parameters:
 
 objects - array of objects to join,
 
 separator - character used as separator.
 
 Returns:
 
 joined string.
 - join
```
public static String join(Object[] objects,
 String separator)
```
 Join array of objects, converted to string, using specified specified separator. Returns null if given objects array is null and empty if empty. If separator is null uses space string instead, like invoking join(Iterable). Null objects or empty strings from given objects parameter are ignored.
 
 Parameters:
 
 objects - array of objects to join,
 
 separator - string used as separator.
 
 Returns:
 
 joined string.
 - join
```
public static String join(Iterable<?> objects)
```
 Join collection of objects, converted to string, using space as separator. Returns null if given objects array is null and empty if empty.
 
 Parameters:
 
 objects - collection of objects to join.
 
 Returns:
 
 joined string.
 - join
```
public static String join(Iterable<?> objects,
 char separator)
```
 Join collection of objects, converted to string, using specified char separator. Returns null if given objects array is null and empty if empty.
 
 Parameters:
 
 objects - collection of objects to join,
 
 separator - character used as separator.
 
 Returns:
 
 joined string.
 - join
```
public static String join(Iterable<?> objects,
 String separator)
```
 Join collection of objects, converted to string, using specified string separator.Concatenates strings from collection converted to string but take care to avoid null items. Uses given separator between strings. Returns null if given objects array is null and empty if empty. If separator is null uses space string instead, like invoking join(Iterable). Null objects or empty strings from given objects parameter are ignored.
 
 Parameters:
 
 objects - collection of objects to join,
 
 separator - string used as separator.
 
 Returns:
 
 joined string.
 - split
```
public static List<String> split(String string,
 char... separators)
```
 Splits string into not empty, trimmed items, using specified separator(s) or space if no separator provided. Please note that returned list does not contain empty items and that all items are trimmed using standard String.trim().
 Returns null if string argument is null and empty list if is empty. This method supports a variable number of separator characters - as accepted by isSeparator(char, char...) predicate; if none given uses space.
 
 Parameters:
 
 string - source string,
 
 separators - variable number of characters used as separators.
 
 Returns:
 
 strings list, possible empty.
 - isSeparator
```
private static boolean isSeparator(char character,
 char... separators)
```
 Test if character is a separator as defined by given separators list. If separator list is empty consider used DEFAULT_SEPARATORS. This predicate is designed specifically for split(String, char...) operation.
 
 Parameters:
 
 character - character to test if usable as separator,
 
 separators - variable number of separator characters.
 
 Returns:
 
 true if character is a separator, as defined by this method.
 - split
```
public static List<String> split(String string,
 String separator)
```
 Splits string using specified string separator and returns trimmed values. Returns null if string argument is null and empty list if is empty.
 
 Parameters:
 
 string - source string,
 
 separator - string used as separator.
 
 Returns:
 
 strings list, possible empty.
 - splitPairs
```
public static List<Pair> splitPairs(String string,
 char pairsSeparator,
 char componentsSeparator)
```
 Split string using given pairs separator and every pair using pair component separator. Return the list of pair instances, possible empty if string value is empty. Returns null if string value is null.
 Returned pair components are trimmed for spaces. This means that spaces around separators are eliminated; this is true for both pairs and pair components separators. For example, " john : doe ; jane : doe ; " will return Pair("john", "doe"), Pair("jane", "doe").
 Trailing pairs separator is optional.
 
 Parameters:
 
 string - string value,
 
 pairsSeparator - pairs separator,
 
 componentsSeparator - pair components separator.
 
 Returns:
 
 list of pairs, possible empty.
 
 Throws:
 
 BugError - if a pair is not valid, that is, pair components separator is missing.
 - pair
```
private static Pair pair(String string,
 char separator)
```
 Split string value using given separator and return initialized pair instance. Pair values are trimmed for spaces so that this method eliminates spaces around separator and around string value. For example, " john : doe " will return Pair("john", "doe").
 
 Parameters:
 
 string - string value,
 
 separator - pair components separator.
 
 Returns:
 
 newly create pair instance.
 
 Throws:
 
 BugError - if separator not found.
 - isNumericSuffix
```
private static boolean isNumericSuffix(char c)
```
 Predicate to test if character is numeric value suffix. Numeric suffix are Java standard: L, D and F and lower case.
 
 Parameters:
 
 c - character to test.
 
 Returns:
 
 true if character is numeric value suffix.
 - isNumeric
```
public static boolean isNumeric(String string)
```
 Test if string is a numeric value. Returns false if string argument is null or empty.
 
 Parameters:
 
 string - string to test.
 
 Returns:
 
 true if given string denote a number.
 - isInteger
```
public static boolean isInteger(String string)
```
 Test if string is an integer numeric value. Returns false if string is null or empty.
 
 Parameters:
 
 string - string to test.
 
 Returns:
 
 true if string is an integer.
 - escapeXML
```
public static String escapeXML(String text)
```
 Escape text for reserved XML characters. Replace quotes, apostrophe, ampersand, left and right angular brackets with entities. Return the newly created, escaped string; if text argument is null or empty returns an empty string.
 
 Parameters:
 
 text - string to escape.
 
 Returns:
 
 the newly created string.
 - escapeXML
```
public static void escapeXML(String text,
 Writer writer)
 throws IOException
```
 Escape text for reserved XML characters to a specified writer. This method has the same logic as escapeXML(String) but result is serialized on the given writer. If text parameters is null this method does nothing.
 
 Parameters:
 
 text - string to escape,
 
 writer - writer to serialize resulted escaped string.
 
 Throws:
 
 IOException - if writer operation fails.
 - escapeRegExp
```
public static String escapeRegExp(String string)
```
 Escape string for regular expression reserved characters. Return null if string argument is null and empty if empty.
 
 Parameters:
 
 string - regular expression to escape.
 
 Returns:
 
 newly created, escaped string.
 - escapeFilesPattern
```
public static String escapeFilesPattern(String filesPattern)
```
 Escape files pattern for usage with Java regular expressions. Replace dot with escaped dot and asterisk with match at least one character so that *.html becomes .+\.html. Return null if files pattern argument is null and empty if empty.
 
 Parameters:
 
 filesPattern - files pattern to prepare.
 
 Returns:
 
 files pattern ready to use by regular expression.
 - last
```
public static String last(String string,
 char separator)
```
 Get last string sequence following given character. If separator character is missing from the source string returns entire string. Return null if string argument is null and empty if empty.
 
 Parameters:
 
 string - source string,
 
 separator - character used as separator.
 
 Returns:
 
 last string sequence.
 - firstSentence
```
public static String firstSentence(String text)
```
 Return the first sentence of a string, where a sentence ends with a sentence separator followed be white space. Returns null if text parameter is null. Current version recognizes next sentence separators: dot (.), question mark (?), exclamation mark (!) and semicolon (;).
 
 Parameters:
 
 text - string to scan for first sentence.
 
 Returns:
 
 first sentence from text.
 - firstWord
```
public static String firstWord(String sentence)
```
 Return first word from a sentence. Search for first word separator and return substring before it. As word separator uses space, tab, carriage return, line feed, point, comma, colon, semicolon and open parenthesis, all round, curly, square and angular. Note that point must be followed by space to be considered word separator and ellipsis is part of the word, like in Object... .
 This method returns null if sentence argument is null and empty if empty.
 
 Parameters:
 
 sentence - sentence to be scanned for its first word
 
 Returns:
 
 sentence first word, null or empty.
 - removeFirstWord
```
public static String removeFirstWord(String sentence)
```
 Remove first word from a sentence. First word is recognized using the heuristic from firstWord(String). White spaces after first word are also trimmed. For the purpose of this function white spaces are: space, tab, carriage return, line feed, point, comma, colon and semicolon.
 This method returns null if sentence argument is null and empty if empty.
 
 Parameters:
 
 sentence - sentence to remove first word from.
 
 Returns:
 
 the sentence with first word removed.
 - replaceAll
```
public static String replaceAll(String source,
 Pattern pattern,
 Handler<String,String> handler)
```
 Replace all pattern occurrences using match transformer. This method is the standard replace all but allows for matched pattern transformation via caller code handler. Common usage is to supply match transformer as anonymous instance of Handler interface. If Handler.handle(Object) method returns given match value replace all degrade to standard behavior, and of course there is no need to use it.
```
 Pattern pattern = Pattern.compile("i");
 String text = Strings.replaceAll("This is a text", pattern, new Handler<String, String>()
 {
 public String handle(String match)
 {
 return "" + match + "";
 }
 });
 
```
 In above sample code, after replace all, text will be This is a text.
 Parameters:
 
 source - source string,
 
 pattern - pattern to look for,
 
 handler - match transformer.
 
 Returns:
 
 new string with pattern replaced.
 - injectProperties
```
public static String injectProperties(String string)
 throws BugError
```
 Inject system properties into text with variables. Given text uses standard variable notation ${variable-name} , as known from, for example, Ant or Log4j configuration. This method replace found variable with system property using variable-name as property key. It is a logic flaw if system property is missing.
 For example, injecting system properties into ${log}/app.log will return /var/log/app.log provided there is a system property named log with value /var/log. Note that there is no limit on the number of system properties and/or variables to replace.
 
 Parameters:
 
 string - text with variables.
 
 Returns:
 
 new string with variables replaces.
 
 Throws:
 
 BugError - if system property is missing.
 - injectVariables
```
public static String injectVariables(String template,
 Map<String,String> variables)
```
 Inject string values into variables from a given template string. Template uses de facto standard variable notation, ${variable-name}, where name is the key from given variables hash. It is legal for a variable to be declared into template but be missing from variables hash, in which case variable from template is left unchanged.
 
 Parameters:
 
 template - source string template,
 
 variables - string variables hash.
 
 Returns:
 
 resulting string with variables replaced.
 - trim
```
public static String trim(String string,
 char garbage)
```
 Trim given string. Remove given garbage characters from around the string. This method is smart enough to pair open parenthesis, that is, if given garbage is an open parenthesis eliminates it from beginning of string and closing parenthesis from the end. This is true for all rounded, square, curly and angular parenthesis.
 This method returns null if given source string is null and returns empty string if source string is empty or contains only garbage.
 
 Parameters:
 
 string - source string,
 
 garbage - no longer needed characters at around the string.
 
 Returns:
 
 string with garbage trimmed or null if given string was null
 - trim
```
public static String trim(String string)
```
 Trim white spaces around given string. White space characters are those recognized by Character.isWhitespace(char).
 
 Parameters:
 
 string - string value to trim.
 
 Returns:
 
 string with white spaces trimmed or null if given string was null.
 - removeTrailing
```
public static String removeTrailing(String string,
 char c)
```
 Remove trailing character, if exists.
 
 Parameters:
 
 string - source string,
 
 c - trailing character to eliminate.
 
 Returns:
 
 source string guaranteed to not end in requested character.
 - format
```
public static String format(String format,
 Object... args)
```
 Process formatted string with arguments transform and no illegal format exception. Java string format throws unchecked IllegalFormatException if given string is not well formatted. This method catches it and return original, not formatted string if exception happened. Uses this method instead of Java String whenever source string is not from safe source, that can guaranty its format correctness.
 Return null if format string argument is null and empty if empty. If optional arguments is missing return original string.
 This method takes care to pre-process arguments as follow:
 - replace Class with its canonical name,
 - replace Throwable with exception message or exception class canonical name if null message,
 - replace Thread with concatenation of thread name and thread ID.
 All pre-processed arguments are replaced with string value and format specifier should be also string (%s).
 Parameters:
 
 format - string to format,
 
 args - variable number of arguments related to format.
 
 Returns:
 
 formatted string, possible empty or null.
 - indexOneOf
```
public static int indexOneOf(CharSequence string,
 char... chars)
```
 Search string index of the first character from a series. Traverse string and compare with character from chars series one by one, in sequence. If found return string index; if reach the end of the string return -1.
 
 Parameters:
 
 string - string builder to search on,
 
 chars - characters series.
 
 Returns:
 
 index of first character from series or -1.
 - load
```
public static String load(InputStream inputStream,
 Integer... maxCount)
 throws IOException
```
 Load string from UTF-8 bytes stream then closes it.
 
 Parameters:
 
 inputStream - source input stream,
 
 maxCount - optional maximum number of characters to read, default to MAX_VALUE.
 
 Returns:
 
 string from input stream.
 
 Throws:
 
 NullPointerException - if input stream is null.
 
 IOException - if input stream read operation fails.
 - load
```
public static String load(File file,
 Integer... maxCount)
 throws IOException
```
 Load string from UTF-8 file content.
 
 Parameters:
 
 file - source file,
 
 maxCount - optional maximum character count to load, default to entire file.
 
 Returns:
 
 loaded string, possible empty but never null.
 
 Throws:
 
 IOException - if file not found or file read operation fails.
 - load
```
public static String load(Reader reader,
 Integer... maxCount)
 throws IOException
```
 Load string from character stream then closes it.
 
 Parameters:
 
 reader - source character stream.
 
 maxCount - optional maximum character count to load, default to entire file.
 
 Returns:
 
 loaded string, possible empty but never null.
 
 Throws:
 
 IOException - if read operation fails.
 - save
```
public static void save(CharSequence chars,
 File file)
 throws IOException
```
 Create target file and copy characters into. Copy destination should be a file and this method throws access denied if attempt to write to a directory. This method creates target file if it does not already exist. If target file does exist it will be overwritten and old content lost. If given chars parameter is null or empty this method does nothing.
 Note that this method takes care to create file parent directories.
 
 Parameters:
 
 chars - source characters sequence,
 
 file - target file.
 
 Throws:
 
 FileNotFoundException - if target file does not exist and cannot be created.
 
 IOException - if copy operation fails, including if target is a directory.
 - save
```
public static void save(CharSequence chars,
 Writer writer)
 throws IOException
```
 Copy source characters to requested output characters stream. If given chars parameter is null or empty this method does nothing.
 
 Parameters:
 
 chars - source characters stream,
 
 writer - target writer.
 
 Throws:
 
 IOException - if copy operation fails.
 - save
```
public static void save(CharSequence chars,
 OutputStream outputStream)
 throws IOException
```
 Copy source characters to requested output bytes stream. If given chars parameter is null or empty this method does nothing.
 
 Parameters:
 
 chars - source characters stream,
 
 outputStream - target bytes stream.
 
 Throws:
 
 IOException - if copy operation fails.
 - UUID
```
public static String UUID()
```
 Get universal unique ID. Current implementation is based on UUID.randomUUID() but with dashes removed.
 
 Returns:
 
 universal unique ID.
 - setPrefix
```
public static String setPrefix(String text,
 String prefix)
```
 Ensure a given text start with requested prefix. If text argument is empty returns given prefix; returns null if text argument is null.
 
 Parameters:
 
 text - text to add prefix to, null accepted,
 
 prefix - prefix to force on text start.
 
 Returns:
 
 prefixed text or null.
 - generatePassword
```
public static String generatePassword(int length)
```
 Generate random password of requested length. Generated password contains characters from PASSWORD_DICTIONARY and has exactly requested length.
 
 Parameters:
 
 length - password length, strict positive.
 
 Returns:
 
 random password of requested length.
 - md5
```
public static String md5(String text)
```
 Generate text MD5 hash into hexadecimal format. Returned string will be exactly 32 characters long. This function is designed, but not limited, to store password into databases. Anyway, be aware that MD5 is not a strong enough hash function to be used on public transfers.
 
 Parameters:
 
 text - source text.
 
 Returns:
 
 MD5 hash in hexadecimal format.
 - getProtocol
```
public static String getProtocol(String url)
```
 Get URL protocol or null if given URL does not contains one. Returns null if given URL argument is null or empty.
 
 Parameters:
 
 url - URL to retrieve the protocol.
 
 Returns:
 
 URL protocol, possible null.

Class Strings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

ISO_DATE_FORMAT

QUALIFIED_CLASS_NAME

MEMBER_NAME_PATTERN

DEFAULT_SEPARATORS

DECIMAL_SEPARATOR

GROUPING_SEPARATOR

REGEXP_PATTERN

REPLACE_ARG_REX

DOT_REX

ANY_REX

WHITE_SPACES

SEPARATORS

VARIABLE_PATTERN

PASSWORD_DICTIONARY

HEXA

Constructor Detail

Strings

Method Detail

toCamelCase

toTitleCase

toMemberName

toDashCase

toISO

toString

toString

toPlainText

toPlainText

getMethodAccessor

isQualifiedClassName

isMemberName

concat

join

join

join

join

join

join

split

isSeparator

split

splitPairs

pair

isNumericSuffix

isNumeric

isInteger

escapeXML

escapeXML

escapeRegExp

escapeFilesPattern

last

firstSentence

firstWord

removeFirstWord

replaceAll

injectProperties

injectVariables

trim

trim

removeTrailing

format

indexOneOf

load

load

load

save

save

save

UUID

setPrefix

generatePassword

md5

getProtocol