com.technia.tvc.core.util

Class StringUtils

java.lang.Object

com.technia.tvc.core.util.StringUtils

public final class StringUtils
extends java.lang.Object

This class provides some utility methods for dealing with Strings.

Converting exceptions to Strings

 try {
     // ...
 } catch (Exception ex) {
     String ex = StringUtils.getStackTrace(ex);
     // or
     String ex[] = StringUtils.getStackTraceArray(ex);
     // ...
 }
 

Splitting up Strings

 String s = "Mary had a little lamb";

 String[] toks = StringUtils.split(s, " \t");
 

Concattenating Strings

 String s[] =
     { "Mary", "had", "a", "little", "lamb" };

 String ret = StringUtils.concat(s, " ");
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CRLF Contains the line.separator value
static char[]	EMPTY_CHAR_ARRAY
static java.lang.String	EMPTY_STRING
static java.lang.String[]	EMPTY_STRING_ARRAY

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	addWhitespaceBetweenCharacters(java.lang.String s) Add whitespace between characters in a string
static java.lang.String[]	append(java.lang.String[] origin, java.lang.String s) Adds a value to the end of the array.
static java.util.Map<java.lang.String,java.lang.String>	asPropertyMap(java.lang.String s) Loads the content of the string as a property map.
static java.util.Map<java.lang.String,java.lang.String>	asPropertyMap(java.lang.String s, java.util.Map<java.lang.String,java.lang.String> target) Loads the content of the string as a property map.
static java.lang.String	capitalize(java.lang.String s)
static java.lang.String	concat(java.util.Collection<java.lang.String> strings, char separator)
static java.lang.String	concat(java.util.Collection<java.lang.String> strings, java.lang.String delim) This method concatenates a Collection of strings into a single string, using the given delimiter as a filler between the array elements.
static java.lang.String	concat(java.lang.Object[] objects, java.lang.String delim) This method concatenates an array of strings into a single string, using the given delimiter as a filler between the array elements.
static java.lang.String	concat(java.lang.String[] strings, java.lang.String delim) This method concatenates an array of strings into a single string, using the given delimiter as a filler between the array elements.
static boolean	contains(java.util.Collection<java.lang.String> collection, java.lang.String s) Returns true, if the string is equal to at least one of the strings within the provided collection.
static boolean	contains(java.util.Iterator<java.lang.String> itr, java.lang.String s) Returns true if the Iterator contains the specified string.
static boolean	contains(java.lang.String[] arr, java.lang.String s) Returns true, if the string is equal to at least one of the strings within the provided array.
static boolean	contains(java.lang.String source, java.lang.String search) Checks whether source string contains search
static boolean	contains(java.lang.String source, java.lang.String search, boolean caseSensitive) Checks whether source string contains search
static boolean	contains(java.lang.String str, java.lang.String token, java.lang.String delim, boolean ignoreCase)
static boolean	containsIgnoreCase(java.lang.String source, java.lang.String search) Checks whether source string contains search
static boolean	containsNull(java.lang.String[] arr) Returns true, if the array contains a null element
static boolean	containsWhitespace(java.lang.String s) Returns true if the string contains at least one whitespace character.
static boolean	containsWildCard(java.lang.String s) Returns true if the string contains a question mark or an asterix.
static java.lang.String[]	copy(java.lang.String[] s) Copy a string array.
static java.lang.String	cut(java.lang.String s, int max) Cuts the length of the string if it is longer than max.
static java.lang.String	defaultIfEmpty(java.lang.String value, java.lang.String fallback) Returns the string back if blank returns the fallback
static java.lang.String	emptyIfNull(java.lang.String s)
static java.lang.String[]	emptyIfNull(java.lang.String[] in)
static boolean	equals(java.lang.String left, java.lang.String right) Checks equality of two strings
static boolean	equalsIgnoreCase(java.lang.String left, java.lang.String right) Checks equality of two strings ignoring case
static java.lang.String	escapeJavaString(java.lang.String s) Escapes non printables and other characters in a Java string so that it is syntactically correct.
static java.lang.String	escapeJavaStringForJSON(java.lang.String s) Escapes non valid characters in a Java string so that it is syntactically correct according to JSON specification.
static java.lang.String	escapeSpecial(java.lang.String s) Deprecated. What's so special about it??? Use escapeJavaString(String) instead...
static java.lang.String	escapeString(java.lang.String source) Deprecated. Use escapeXML(String) instead.
static java.lang.String	escapeXML(java.lang.String source) Escapes the string according to XML escaping rules and returns the result.
static void	escapeXML(java.lang.String source, java.lang.StringBuffer out) Deprecated. As of 2010.1.0 use the escapeXML(String, StringBuilder) instead.
static void	escapeXML(java.lang.String source, java.lang.StringBuilder out) Escapes the string according to XML escaping rules and appends the result to the specified buffer.
static void	escapeXML(java.lang.String source, java.io.Writer out) Escapes the string according to XML escaping rules and writes the result to the specified Writer.
static java.lang.String	escapeXMLChar(int ch) Escapes a single character and returns the escaped string.
static void	escapeXMLChar(java.lang.StringBuffer target, int ch) Deprecated. As of 2010.1.0 use the escapeXMLChar(StringBuilder, int) instead.
static void	escapeXMLChar(java.lang.StringBuilder target, int ch) Escapes a single character into the specified StringBuilder.
static java.lang.String	getEntityRef(int ch) Encode special XML characters into the equivalent character references.
static java.lang.String	getEOL() Returns the end-of-line characters used on the current platform.
static java.lang.String	getStackTrace(java.lang.Throwable ex) This method outputs an exception stack-trace to a string
static java.lang.String[]	getStackTraceArray(java.lang.Throwable ex) This method outputs an exception stack-trace to an array of strings, each element containing one line of the stack-trace
static java.lang.String[]	getUniqueValues(java.lang.String[] arr) Returns the unique values within the provided array
static int	indexOf(java.lang.String[] arr, java.lang.String s) Returns the index of the string within the array.
static java.lang.String[]	intersection(java.lang.String[] array1, java.lang.String[] array2) Returns all (unique) strings that both are in array1 AND in array2.
static boolean	isBlank(java.lang.String s) Shorter variant of isOnlyWhitespaceOrEmpty(String)
static boolean	isBoolean(java.lang.String s) Returns true if the string represents the text "true" or "false" (case sensitive match)
static boolean	isEmpty(java.lang.String[] values) Checks if a string array is empty (or null)
static boolean	isFalseOrNo(java.lang.String s)
static boolean	isFalseOrNo(java.lang.String s, boolean defaultValue)
static boolean	isInteger(java.lang.String s)
static boolean	isJavaClassName(java.lang.String s) Checks if a given string is a valid java class name.
static boolean	isJavaIdentifier(java.lang.String identifier) Check if a string is a valid Java identifier.
static boolean	isNotBlank(java.lang.String s)
static boolean	isNullOrEqualToNull(java.lang.String s) Checks if a string is null or equal to "null".
static boolean	isNumber(java.lang.String s)
static boolean	isOnlyWhitespaceOrEmpty(java.lang.String s) Returns true if the string only contains whitespace characters, is empty or if it is null.
static boolean	isTrue(java.lang.String s)
static boolean	isTrue(java.lang.String s, boolean defaultValue)
static boolean	isTrueOrYes(java.lang.String s)
static boolean	isTrueOrYes(java.lang.String s, boolean defaultValue)
static java.lang.String	leftpad(java.lang.String s, int len, char c) Left pads the string with the specified charater, as many times needed in order to get the specified length of the string.
static boolean	match(java.lang.String s, java.lang.String pattern) Performs a match between the string and the pattern.
static boolean	matchAny(java.lang.String str, java.lang.String[] patterns) Performs a match between the string and the patterns.
static boolean	matchAnyIgnoreCase(java.lang.String str, java.lang.String[] patterns) Performs a match between the string and the patterns ignoring case.
static boolean	matchIgnoreCase(java.lang.String string, java.lang.String pattern) Performs a match between the string and the pattern ignoring case.
static java.lang.String	next(java.util.Iterator<java.lang.String> itr) Returns the next string of the iterator
static java.lang.String	next(java.util.Iterator<java.lang.String> itr, java.lang.String fallback) Returns the next string of the iterator
static java.lang.String	normalizeSpace(java.lang.String str) Trim white space characters from both sides of the specified string and redundant white space characters from within the string.
static java.lang.String	notNull(java.lang.String s) Checks if the argument is null and if so returns an empty string.
static java.lang.String	nullIfEmpty(java.lang.String s)
static java.util.Map<java.lang.String,java.lang.String>	parseArgs(java.lang.String inputString) Parses a string into an argument map.
static java.util.Map<java.lang.String,java.lang.String>	parseArgs(java.lang.String inputString, char argSeparator, boolean caseInsensitiveKeys)
static java.util.Map<java.lang.String,java.lang.String>	parseArgs(java.lang.String inputString, char valueSeparator, char argSeparator, boolean caseInsensitiveKeys, boolean escapeBackslashes) Parses a string into an argument map.
static boolean	parseBoolean(java.lang.String s, boolean defaultValue) Parses a value into a boolean.
static double	parseDouble(java.lang.String s, double defaultValue) Safe parsing of a string to a double
static int	parseInt(java.lang.String s, int i) Safe parsing of a string to an integer.
static long	parseLong(java.lang.String s, long defaultValue) Safe parsing of a string to an long.
static java.lang.String	removeAllWhitespaces(java.lang.String s) Removes all whitespaces from a string.
static java.util.Collection<java.lang.String>	removeBlanks(java.util.Collection<java.lang.String> input) Removes blank strings from the given list and returns new list
static java.lang.String	removeBreakAtEnd(java.lang.String s) Removes the CRLF at the end of the specified string.
static java.lang.String	removeConsecutiveWhitespaces(java.lang.String s) Removes any multiple occurence of consecutive whitespaces.
static java.lang.String	removeLeadingCharacter(java.lang.String str, char removeChar) Removes the specified leading character.
static java.lang.String[]	removeNulls(java.lang.String[] in) Removes null items from the string array and returns either the same array if no items were null, or a new array containing only the non-null items from the source array.
static java.lang.String	removeTrailingCharacter(java.lang.String str, char removeChar) Removes the specified trailing character.
static java.lang.String	replace(java.lang.String orig, java.lang.String pattern, java.lang.String newvalue) This method replaces the occurrences of a given substring with another string returning the converted string
static java.lang.String[]	reverse(java.lang.String[] arr) Reverses the item within an array...
static java.lang.String	rightpad(java.lang.String s, int len, char c) Right pads the string with the specified charater, as many times needed in order to get the specified length of the string.
static void	sort(java.util.List<java.lang.String> s) Sort string values in the specified list.
static void	sort(java.lang.String[] s) Sort string values in the specified array.
static java.lang.String[]	split(java.lang.String str) This method splits a string into an array of substrings
static java.lang.String[]	split(java.lang.String str, java.lang.String delim) This method splits a string into an array of substrings
static java.lang.String[]	splitAndEscape(java.lang.String str, java.lang.String delim) Splits the string using the split(String, String) method and escapes each entry in the array using the escapeJavaString(String) method.
static java.util.List<java.lang.String>	splitToList(java.lang.String s, java.lang.String delimiter) Split the string into a list.
static void	splitToList(java.lang.String s, java.lang.String delim, java.util.List<java.lang.String> list) Split the string and add the substrings to the specified list.
static boolean	startsWith(java.lang.String source, java.lang.String prefix) Checks whether source string starts with prefix
static boolean	startsWith(java.lang.String source, java.lang.String prefix, boolean caseSensitive) Checks whether source string starts with prefix
static boolean	startsWithIgnoreCase(java.lang.String source, java.lang.String prefix) Checks whether source string starts with prefix
static java.lang.String	stripNonValidXMLCharacters(java.lang.String source) This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard.
static java.lang.String[]	subarr(java.lang.String[] arr, int start, int len) Returns a sub array from the given array starting at start and ending at start+len
static java.lang.String[]	toArray(matrix.util.StringList sl) Converts the StringList into an array of strings.
static java.util.Enumeration<java.lang.String>	toEnumeration(java.util.StringTokenizer st) Converts a StringTokenizer to an Enumeration of Strings.
static java.lang.String	toLowerCase(java.lang.String s)
static java.lang.String	toString(java.lang.String value, java.lang.String fallback) Returns the string back if blank returns the fallback
static java.lang.String[]	toStringArray(java.util.Collection<java.lang.String> c) Convert the specified collection into an array of strings.
static java.lang.String[]	toStringArray(java.lang.Object[] array) Converts any object array to an array of strings.
static java.lang.String[]	toStringArray(java.lang.String s)
static matrix.util.StringList	toStringList(java.util.Collection<java.lang.String> c)
static matrix.util.StringList	toStringList(java.lang.String... a)
static java.lang.String	toUpperCase(java.lang.String s)
static java.lang.String	trim(java.lang.String str)
static java.lang.String	trim(java.lang.String str, char removeChar) Trims the specified string from any specified character
static java.lang.String	trimLeft(java.lang.String str) Trim white space characters from the left of the specified string.
static java.lang.String	trimRight(java.lang.String str) Trim white space characters from the right of the specified string.
static java.lang.String	trimToEmpty(java.lang.String s)
static java.lang.String	trimToNull(java.lang.String s)
static java.lang.String	unquote(java.lang.String str) Removes the trailing and ending quote (or double quote) character.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_STRING_ARRAY

public static final java.lang.String[] EMPTY_STRING_ARRAY

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

EMPTY_CHAR_ARRAY

public static final char[] EMPTY_CHAR_ARRAY

CRLF

public static final java.lang.String CRLF

Contains the line.separator value

Since:

6.4.1

Method Detail

getStackTrace

public static java.lang.String getStackTrace(java.lang.Throwable ex)

This method outputs an exception stack-trace to a string

Parameters:

ex - the exception

Returns:

a String containing the stacktrace of the exception

getStackTraceArray

public static java.lang.String[] getStackTraceArray(java.lang.Throwable ex)

This method outputs an exception stack-trace to an array of strings, each element containing one line of the stack-trace

Parameters:

ex - the exception

Returns:

a String-array containing the stacktrace of the exception

append

public static java.lang.String[] append(java.lang.String[] origin,
                        java.lang.String s)

Adds a value to the end of the array.

Parameters:

origin - The origin array of strings. if null, a new string array will be created.

s - The string to append to the array.

Returns:

A new array containing the new elements

intersection

public static java.lang.String[] intersection(java.lang.String[] array1,
                              java.lang.String[] array2)

Returns all (unique) strings that both are in array1 AND in array2.

Parameters:

array1 - An array of strings

array2 - Another array

Returns:

The unique strings that both are in array1 AND in array2.

split

public static java.lang.String[] split(java.lang.String str)

This method splits a string into an array of substrings

Parameters:

str - the string to split

Returns:

an array of substrings

split

public static java.lang.String[] split(java.lang.String str,
                       java.lang.String delim)

This method splits a string into an array of substrings

Parameters:

str - the string to split

delim - a string containing all tokes used for splitting

Returns:

an array of substrings

concat

public static java.lang.String concat(java.lang.String[] strings,
                      java.lang.String delim)

This method concatenates an array of strings into a single string, using the given delimiter as a filler between the array elements. If the delimiter is null, the string elements are concatenated without additional delimiters

Parameters:

strings - an array of strings

delim - a delimiter string that is put between the former string elements during the concatination

Returns:

a single String

concat

public static java.lang.String concat(java.util.Collection<java.lang.String> strings,
                      char separator)

Parameters:

strings - A collection of string instance

separator - A character used for separating the items

Returns:

A string containing the values from the collection concatenated with the specified separator

Since:

6.0.1

concat

public static java.lang.String concat(java.lang.Object[] objects,
                      java.lang.String delim)

This method concatenates an array of strings into a single string, using the given delimiter as a filler between the array elements. If the delimiter is null, the string elements are concatenated without additional delimiters

Parameters:

objects - an array of objects

delim - a delimiter string that is put between the former string elements during the concatination

Returns:

a single String

Since:

4.0

concat

public static java.lang.String concat(java.util.Collection<java.lang.String> strings,
                      java.lang.String delim)

This method concatenates a Collection of strings into a single string, using the given delimiter as a filler between the array elements. If the delimiter is null, the string elements are concatenated without additional delimiters

Parameters:

strings - an array of strings

delim - a delimiter string that is put between the former string elements during the concatenation

Returns:

a single String

Since:

3.6

removeBreakAtEnd

public static java.lang.String removeBreakAtEnd(java.lang.String s)

Removes the CRLF at the end of the specified string.

Parameters:

s - the string to remove the CRLF at the end from.

Since:

5.1.1

removeTrailingCharacter

public static java.lang.String removeTrailingCharacter(java.lang.String str,
                                       char removeChar)

Removes the specified trailing character.

Parameters:

str -

removeChar -

Returns:

The modified string.

Since:

2011.2.1

removeConsecutiveWhitespaces

public static java.lang.String removeConsecutiveWhitespaces(java.lang.String s)

Removes any multiple occurence of consecutive whitespaces.

For example, a string containing following text: (the whitespace is marked).

  A  TEXT         WITH    SOME SPACES   .TEXT
   ^^    ^^^^^^^^^    ^^^^    ^      ^^^
 

Will after calling this method be:

 A TEXT WITH SOME SPACES .TEXT
  ^    ^    ^    ^      ^
 

Parameters:

s -

Returns:

The modified string.

Since:

2015.3.0 (moved from File Manager)

removeLeadingCharacter

public static java.lang.String removeLeadingCharacter(java.lang.String str,
                                      char removeChar)

Removes the specified leading character.

Parameters:

str -

removeChar -

Returns:

The modified string.

Since:

2011.2.1

containsWhitespace

public static boolean containsWhitespace(java.lang.String s)

Returns true if the string contains at least one whitespace character.

Since:

5.1.1

replace

public static java.lang.String replace(java.lang.String orig,
                       java.lang.String pattern,
                       java.lang.String newvalue)

This method replaces the occurrences of a given substring with another string returning the converted string

Parameters:

orig - the original string

pattern - the pattern to replace

newvalue - the new value to replace the pattern with

Returns:

a new string

getEntityRef

public static java.lang.String getEntityRef(int ch)

Encode special XML characters into the equivalent character references. These five: <>"'& are defined by default for all XML documents.

escapeXML

@Deprecated
public static void escapeXML(java.lang.String source,
                        java.lang.StringBuffer out)

Deprecated. As of 2010.1.0 use the escapeXML(String, StringBuilder) instead.

Escapes the string according to XML escaping rules and appends the result to the specified buffer.

Parameters:

source - The string to escape.

out - The buffer to which the results will be appended.

Since:

6.0.0

escapeXMLChar

@Deprecated
public static void escapeXMLChar(java.lang.StringBuffer target,
                            int ch)

Deprecated. As of 2010.1.0 use the escapeXMLChar(StringBuilder, int) instead.

Escapes a single character into the specified stringbuffer.

escapeString

@Deprecated
public static java.lang.String escapeString(java.lang.String source)

Deprecated. Use escapeXML(String) instead.

escapeXML

public static java.lang.String escapeXML(java.lang.String source)

Escapes the string according to XML escaping rules and returns the result.

Parameters:

source - The string to escape.

Since:

6.0.0

escapeXMLChar

public static java.lang.String escapeXMLChar(int ch)

Escapes a single character and returns the escaped string.

escapeXML

public static void escapeXML(java.lang.String source,
             java.lang.StringBuilder out)

Escapes the string according to XML escaping rules and appends the result to the specified buffer.

Parameters:

source - The string to escape.

out - The buffer to which the results will be appended.

Since:

2010.1.0

escapeXMLChar

public static void escapeXMLChar(java.lang.StringBuilder target,
                 int ch)

Escapes a single character into the specified StringBuilder.

Parameters:

target - The string builder to append the escaped character into

ch - The character to escape

Since:

2010.1.0

escapeXML

public static void escapeXML(java.lang.String source,
             java.io.Writer out)
                      throws java.io.IOException

Escapes the string according to XML escaping rules and writes the result to the specified Writer.

Parameters:

source - The string to escape.

out - The Writer to which the results will be written.

Throws:

java.io.IOException

Since:

6.0.0

escapeSpecial

@Deprecated
public static java.lang.String escapeSpecial(java.lang.String s)

Deprecated. What's so special about it??? Use escapeJavaString(String) instead...

escapeJavaString

public static java.lang.String escapeJavaString(java.lang.String s)

Escapes non printables and other characters in a Java string so that it is syntactically correct.

Example:

System.out.println(escapeJavaString("Row 1\r\nRow 2\n\tRow 3"));

Will produce the output:

Row 1\r\nRow 2\n\tRow 3

as apposed to:

Row 1
Row 2
Row 3

Parameters:

s - The string to escape.

Returns:

The escaped string.

Since:

6.0.0

escapeJavaStringForJSON

public static java.lang.String escapeJavaStringForJSON(java.lang.String s)

Escapes non valid characters in a Java string so that it is syntactically correct according to JSON specification.

Parameters:

s - The string to escape.

Returns:

The escaped string.

Since:

2012.2.0

trim

public static java.lang.String trim(java.lang.String str,
                    char removeChar)

Trims the specified string from any specified character

Parameters:

str -

removeChar -

Returns:

The modified string.

trim

public static java.lang.String trim(java.lang.String str)

trimLeft

public static java.lang.String trimLeft(java.lang.String str)

Trim white space characters from the left of the specified string.

Parameters:

str - the string to trim

Returns:

the newly trimmed string

trimRight

public static java.lang.String trimRight(java.lang.String str)

Trim white space characters from the right of the specified string.

Parameters:

str - the string to trim

Returns:

the newly trimmed string

normalizeSpace

public static java.lang.String normalizeSpace(java.lang.String str)

Trim white space characters from both sides of the specified string and redundant white space characters from within the string.

Parameters:

str - the string to trim

Returns:

the newly trimmed string

matchIgnoreCase

public static boolean matchIgnoreCase(java.lang.String string,
                      java.lang.String pattern)

Performs a match between the string and the pattern ignoring case.

Parameters:

string - the string.

pattern - the pattern.

Returns:

true if the string match the pattern.

match

public static boolean match(java.lang.String s,
            java.lang.String pattern)

Performs a match between the string and the pattern.

Parameters:

s - the string.

pattern - the pattern.

Returns:

true if the string match the pattern.

matchAny

public static boolean matchAny(java.lang.String str,
               java.lang.String[] patterns)

Performs a match between the string and the patterns.

Parameters:

str - the string.

patterns - the patterns.

Returns:

true if the string match any of the patterns.

matchAnyIgnoreCase

public static boolean matchAnyIgnoreCase(java.lang.String str,
                         java.lang.String[] patterns)

Performs a match between the string and the patterns ignoring case.

Parameters:

str - the string.

patterns - the patterns.

Returns:

true if the string match any of the patterns.

sort

public static void sort(java.lang.String[] s)

Sort string values in the specified array.

sort

public static void sort(java.util.List<java.lang.String> s)

Sort string values in the specified list.

isOnlyWhitespaceOrEmpty

public static boolean isOnlyWhitespaceOrEmpty(java.lang.String s)

Returns true if the string only contains whitespace characters, is empty or if it is null.

Since:

3.6

toStringArray

public static java.lang.String[] toStringArray(java.lang.String s)

toStringArray

public static java.lang.String[] toStringArray(java.lang.Object[] array)

Converts any object array to an array of strings. This method will use String.valueOf(Object) to convert an object to a String. If the argument is an instance of String[] it will be returned as is.

Parameters:

array - An object array.

Returns:

A string array.

Since:

2009.1

toArray

public static java.lang.String[] toArray(matrix.util.StringList sl)

Converts the StringList into an array of strings.

Since:

2010.1.0

toStringArray

public static java.lang.String[] toStringArray(java.util.Collection<java.lang.String> c)

Convert the specified collection into an array of strings.

Since:

4.0

copy

public static java.lang.String[] copy(java.lang.String[] s)

Copy a string array.

Parameters:

s - The array to copy.

Returns:

A copy of the array.

Since:

6.1.3

cut

public static java.lang.String cut(java.lang.String s,
                   int max)

Cuts the length of the string if it is longer than max.

If the string is cut, the following three letters are appended: ...

For example, calling this method with the args:

1. "a string to be cut"
2. 8

The returned string will be: a str...

Since:

4.0

contains

public static boolean contains(java.lang.String[] arr,
               java.lang.String s)

Returns true, if the string is equal to at least one of the strings within the provided array.

Parameters:

arr - An array.

s -

Since:

5.0

containsNull

public static boolean containsNull(java.lang.String[] arr)

Returns true, if the array contains a null element

Parameters:

arr - An array.

Since:

2011.3.0

contains

public static boolean contains(java.util.Collection<java.lang.String> collection,
               java.lang.String s)

Returns true, if the string is equal to at least one of the strings within the provided collection.

Parameters:

collection - A collection of strings.

s - The string to check

Since:

2011.2.0

contains

public static boolean contains(java.util.Iterator<java.lang.String> itr,
               java.lang.String s)

Returns true if the Iterator contains the specified string.

Parameters:

itr - An iterator of strings

s - The string to check

Returns:

True, if the iterator holds a value that is equal to the string argument.

Since:

2010.2.0

getEOL

public static java.lang.String getEOL()

Returns the end-of-line characters used on the current platform.

Returns:

The EOL characters for this platform.

Since:

5.0.0

getUniqueValues

public static java.lang.String[] getUniqueValues(java.lang.String[] arr)

Returns the unique values within the provided array

toStringList

public static matrix.util.StringList toStringList(java.lang.String... a)

Parameters:

a - An array of strings.

Returns:

A mx1 StringList

Since:

5.1

toStringList

public static matrix.util.StringList toStringList(java.util.Collection<java.lang.String> c)

Parameters:

c - A collection of strings.

Returns:

A mx1 StringList

Since:

5.1

isInteger

public static boolean isInteger(java.lang.String s)

Parameters:

s - A string.

Returns:

Whether this string is an integer (w/wo leading minus sign).

Since:

5.1

isBoolean

public static boolean isBoolean(java.lang.String s)

Returns true if the string represents the text "true" or "false" (case sensitive match)

Parameters:

s - The string to test

Returns:

True if the value is a boolean; e.g. either "true" or "false".

Since:

2011.3.0

isNumber

public static boolean isNumber(java.lang.String s)

Parameters:

s - A string.

Returns:

Whether this string is a number (w/wo leading minus sign). This method supports both comma and dot as decimal separators.

Since:

5.1

isTrue

public static boolean isTrue(java.lang.String s)

Parameters:

s - A string.

Returns:

Whether the string is equal to "true" or not.

Since:

5.1

isTrue

public static boolean isTrue(java.lang.String s,
             boolean defaultValue)

Parameters:

s - A string.

defaultValue - The default value is returned if the supplied string is null.

Returns:

Whether the string is equal to "true" or not.

Since:

6.0.0

parseBoolean

public static boolean parseBoolean(java.lang.String s,
                   boolean defaultValue)

Parses a value into a boolean. This method returns true if the string equals to "true" or false if the string equals to "false". Note, the string matching is case insensitive.

For any other string, the defaultValue is returned.

Parameters:

s - The string to be parsed into a boolean

defaultValue - The default value to be returned if the s argument is not a boolean

Returns:

A boolean according to description above.

Since:

2015.3.0

isTrueOrYes

public static boolean isTrueOrYes(java.lang.String s)

Parameters:

s - A string.

Returns:

True if the string is equal to "true" or "yes".

Since:

6.0.0

isTrueOrYes

public static boolean isTrueOrYes(java.lang.String s,
                  boolean defaultValue)

Parameters:

s - A string.

defaultValue - The default value is returned if the supplied string is null.

Returns:

True if the string is equal to "true" or "yes".

Since:

6.0.0

isFalseOrNo

public static boolean isFalseOrNo(java.lang.String s)

Parameters:

s - A string.

Returns:

True if the string is equal to "false" or "no".

Since:

2012.2.0

isFalseOrNo

public static boolean isFalseOrNo(java.lang.String s,
                  boolean defaultValue)

Parameters:

s - A string.

defaultValue - The default value is returned if the supplied string is null.

Returns:

True if the string is equal to "false" or "no".

Since:

2012.2.0

isJavaIdentifier

public static boolean isJavaIdentifier(java.lang.String identifier)

Check if a string is a valid Java identifier. To check if the string is a valid java class name (i.e., including package names) use isJavaClassName(String).

Parameters:

identifier - The name of a Java identifier.

Returns:

Returns whether or not the identifier is valid.

Since:

5.1.1

splitAndEscape

public static java.lang.String[] splitAndEscape(java.lang.String str,
                                java.lang.String delim)

Splits the string using the split(String, String) method and escapes each entry in the array using the escapeJavaString(String) method.

Parameters:

str - The string to split

delim - The delimiters to split upon

Returns:

An array, where each entry has been escaped.

Since:

5.1.3

subarr

public static java.lang.String[] subarr(java.lang.String[] arr,
                        int start,
                        int len)

Returns a sub array from the given array starting at start and ending at start+len

contains

public static boolean contains(java.lang.String str,
               java.lang.String token,
               java.lang.String delim,
               boolean ignoreCase)

Parameters:

str - The string to check.

token - The token to search for.

delim - The delimiter chars that will be used to split the string when searching for tokens.

ignoreCase - Whether to ignore case when checking if a token equals the specified token.

Returns:

Returns true if the token was found in the string.

Since:

6.0.0

containsWildCard

public static boolean containsWildCard(java.lang.String s)

Returns true if the string contains a question mark or an asterix. I.e. if the string is a "Matrix" pattern string.

Parameters:

s - The string to check

Returns:

True if atleast one wildcard exists.

Since:

6.1.0

isNullOrEqualToNull

public static boolean isNullOrEqualToNull(java.lang.String s)

Checks if a string is null or equal to "null". If MatrixOne code was designed properly we wouldn't need this method.

Parameters:

s - A String.

Returns:

Returns true if it is null or equal to "null".

Since:

6.1.2

isJavaClassName

public static boolean isJavaClassName(java.lang.String s)

Checks if a given string is a valid java class name. To check if a string is a valid java identifier use isJavaIdentifier(String).

Parameters:

s - Possibly a java class name.

Returns:

Returns true if the string is a valid java class name.

Since:

6.1.5

splitToList

public static java.util.List<java.lang.String> splitToList(java.lang.String s,
                                           java.lang.String delimiter)

Split the string into a list. The returned list will be immutable.

Parameters:

s - The string to split.

delimiter - The delimiter.

Returns:

Returns a list containing the parts.

Since:

6.1.7

splitToList

public static void splitToList(java.lang.String s,
               java.lang.String delim,
               java.util.List<java.lang.String> list)

Split the string and add the substrings to the specified list.

Parameters:

s - The string to split.

delim - The delimiter.

list - The list to add the subtrings to.

Since:

2009.1

notNull

public static java.lang.String notNull(java.lang.String s)

Checks if the argument is null and if so returns an empty string.

Parameters:

s - A string.

Returns:

Returns an empty string if the argument is null, otherwise the argument is returned unchanged.

Since:

6.2.1

indexOf

public static int indexOf(java.lang.String[] arr,
          java.lang.String s)

Returns the index of the string within the array. If the array does not contain the item, -1 is returned.

Parameters:

arr - An array of string instances

s - A string

Returns:

The index, or -1 if not in the array.

Since:

6.2.1

leftpad

public static java.lang.String leftpad(java.lang.String s,
                       int len,
                       char c)

Left pads the string with the specified charater, as many times needed in order to get the specified length of the string.

Parameters:

s - The string to pad

len - The desired length of the string

c - The character to pad with

Since:

6.3.0

rightpad

public static java.lang.String rightpad(java.lang.String s,
                        int len,
                        char c)

Right pads the string with the specified charater, as many times needed in order to get the specified length of the string.

Parameters:

s - The string to pad

len - The desired length of the string

c - The character to pad with

Since:

6.3.0

nullIfEmpty

public static java.lang.String nullIfEmpty(java.lang.String s)

Parameters:

s - The string

Returns:

The string unless it is null or only contains whitespace characters, otherwise null is returned.

Since:

2009.1

emptyIfNull

public static java.lang.String emptyIfNull(java.lang.String s)

Parameters:

s - The string

Returns:

The EMPTY_STRING if the parameter is null, otherwise the string as provided is returned as-is.

Since:

2010.3.0

emptyIfNull

public static java.lang.String[] emptyIfNull(java.lang.String[] in)

Parameters:

in - The array to check

Returns:

The EMPTY_STRING_ARRAY if the in parameter is null, otherwise the array as provided is returned as-is

Since:

2015.1.0

removeNulls

public static java.lang.String[] removeNulls(java.lang.String[] in)

Removes null items from the string array and returns either the same array if no items were null, or a new array containing only the non-null items from the source array.

Parameters:

in - The array to check.

Returns:

A string array (either the same or a new), or null (if the argument was null).

Since:

2009.3.0

parseInt

public static int parseInt(java.lang.String s,
           int i)

Safe parsing of a string to an integer.

Parameters:

s - The text to parse

i - The default value, if unable to parse.

Returns:

The parsed value

Since:

2010.1.0

parseLong

public static long parseLong(java.lang.String s,
             long defaultValue)

Safe parsing of a string to an long.

Parameters:

s - The text to parse

defaultValue - The default value, if unable to parse.

Returns:

The parsed value

Since:

2015.3.0

parseDouble

public static double parseDouble(java.lang.String s,
                 double defaultValue)

Safe parsing of a string to a double

Parameters:

s - The text to parse into a double

defaultValue - The default value, if unable to parse the string

Returns:

The parsed value

Since:

2010.1.1

toEnumeration

public static java.util.Enumeration<java.lang.String> toEnumeration(java.util.StringTokenizer st)

Converts a StringTokenizer to an Enumeration of Strings. Note that the StringTokenizer implements Enumeration<Object> and not an Enumeration<String> as one would like to (due to compatibility reasons).

Parameters:

st - The string tokenizer

Returns:

An enumeration

Since:

2010.1.0

unquote

public static java.lang.String unquote(java.lang.String str)

Removes the trailing and ending quote (or double quote) character.

E.g. if the str contains:

• "the string"
• 'the string'

The return value is the string

Parameters:

str -

Returns:

The modified string.

Since:

2010.3.0

toLowerCase

public static java.lang.String toLowerCase(java.lang.String s)

Parameters:

s - The string to convert to lower case

Returns:

The string converted to lowercase, or null, if the argument were null

Since:

2011.2.0

toUpperCase

public static java.lang.String toUpperCase(java.lang.String s)

Parameters:

s - The string to convert to upper case

Returns:

The string converted to upper case, or null, if the argument were null

Since:

2011.2.0

reverse

public static java.lang.String[] reverse(java.lang.String[] arr)

Reverses the item within an array...

Parameters:

arr -

Returns:

A new modified array.

Since:

2011.2.0

parseArgs

public static java.util.Map<java.lang.String,java.lang.String> parseArgs(java.lang.String inputString)

Parses a string into an argument map. This method does:

 return StringUtils.parseArgs(s, '=', '|', false, true);
 

E.g. the pipe character '|' is used to separate multiple key/value pairs and the '=' is used to separate the key from its value.

Parameters:

inputString - The string to parse into an argument map

Returns:

A map where the key is the arg name and the value is the arg value. This method never returns null, however, the returned map might be empty in case the string passed as argument is null or empty or not following the rules as stated above.

Since:

2011.3.0

See Also:

parseArgs(String, char, boolean), parseArgs(String, char, char, boolean, boolean)

parseArgs

public static java.util.Map<java.lang.String,java.lang.String> parseArgs(java.lang.String inputString,
                                                         char argSeparator,
                                                         boolean caseInsensitiveKeys)

parseArgs

public static java.util.Map<java.lang.String,java.lang.String> parseArgs(java.lang.String inputString,
                                                         char valueSeparator,
                                                         char argSeparator,
                                                         boolean caseInsensitiveKeys,
                                                         boolean escapeBackslashes)

Parses a string into an argument map. The format of the string should follow this spec:

     inputString  ::= <arg>[<argSeparator><arg>]
     arg          ::= <name><valueSeparator>;<value>
     name         ::= string
     value        ::= string
 

NOTE: The backslash character '\' is used for escaping if the argument escapeBackslashes is true.

E.g. if the arg name contains a '\' or the valueSeparator character, these needs to be escaped. Also, if the arg value contains a '\' or 'the argSeparator char, these also needs to be escaped.

The table below illustrates some examples and what return value is exepected (the separator char is '|' in this case and the value separator is '='):

Input String	Parsed Map
test=value1|foo=bar|tvc=great	test value1 foo bar tvc great
t\\e\=st=val\|\\\|ue1|f\\o\\o=b\|a\|r|tvc=great	t\e=st val|\|ue1 f\o\o b|a|r tvc great

Parameters:

inputString - The string to parse into an argument map

valueSeparator - The separator used to separate a key/value pair.

argSeparator - The character used to separate multiple arguments.

caseInsensitiveKeys - True to construct a map that allows querying the map in a case insensitive way.

escapeBackslashes - True to support escaping using the backslash character

Returns:

A map where the key is the arg name and the value is the arg value. This method never returns null, however, the returned map might be empty in case the string passed as argument is null or empty or not following the rules as stated above.

Since:

2011.3.0

asPropertyMap

public static java.util.Map<java.lang.String,java.lang.String> asPropertyMap(java.lang.String s)

Loads the content of the string as a property map. The content of the string should be according to the same format as java.util.Properties uses since we are loading/parsing the data via the load method.

Parameters:

s - The string to load

Returns:

A map

Since:

2011.3.0

asPropertyMap

public static java.util.Map<java.lang.String,java.lang.String> asPropertyMap(java.lang.String s,
                                                             java.util.Map<java.lang.String,java.lang.String> target)

Loads the content of the string as a property map. The content of the string should be according to the same format as java.util.Properties uses since we are loading/parsing the data via the load method.

Parameters:

s - The string to load

target - The target map. If null, a new HashMap is created.

Returns:

The map we filled

Since:

2014.2.0

isBlank

public static boolean isBlank(java.lang.String s)

Shorter variant of isOnlyWhitespaceOrEmpty(String)

Parameters:

s - The string to test

Returns:

True if the string argument was null or contained just whitespace characters.

Since:

2013.2.0

isNotBlank

public static boolean isNotBlank(java.lang.String s)

Parameters:

s - The string to test.

Returns:

True if the string argument was NOT null or contained any non whitespace treated character.

Since:

2013.2.0

trimToNull

public static java.lang.String trimToNull(java.lang.String s)

Parameters:

s - The string to be trimmed

Returns:

The trimmed string, or null, if the string only contains whitespaces.

Since:

2013.2.0

trimToEmpty

public static java.lang.String trimToEmpty(java.lang.String s)

Parameters:

s - The string to be trimmed

Returns:

The trimmed string. Note that this method will never return null, if the input string was null, an empty stirng will be returned.

Since:

2013.2.0

capitalize

public static java.lang.String capitalize(java.lang.String s)

Parameters:

s - The string to be capitalized.

Returns:

The capitalized string

Since:

2013.2.0

equals

public static boolean equals(java.lang.String left,
             java.lang.String right)

Checks equality of two strings

Parameters:

left - The string to be compared for equality.

right - The string to be compared for equality.

Returns:

True if both strings are equal

Since:

2014.2.0

equalsIgnoreCase

public static boolean equalsIgnoreCase(java.lang.String left,
                       java.lang.String right)

Checks equality of two strings ignoring case

Parameters:

left - The string to be compared for equality.

right - The string to be compared for equality.

Returns:

True if both strings are equal ignoring case

Since:

2017.1.0

contains

public static boolean contains(java.lang.String source,
               java.lang.String search)

Checks whether source string contains search

Parameters:

source - The string.

search - The string.

Returns:

True if source contains search

Since:

2014.2.0

contains

public static boolean contains(java.lang.String source,
               java.lang.String search,
               boolean caseSensitive)

Checks whether source string contains search

Parameters:

source - The string

search - The string

caseSensitive - boolean

Returns:

True if source contains search

Since:

2014.2.0

containsIgnoreCase

public static boolean containsIgnoreCase(java.lang.String source,
                         java.lang.String search)

Checks whether source string contains search

Parameters:

source - The string

search - The string

Returns:

True if source contains search

Since:

2014.2.0

startsWith

public static boolean startsWith(java.lang.String source,
                 java.lang.String prefix)

Checks whether source string starts with prefix

Parameters:

source - The string

prefix - The string

Returns:

True if source starts with prefix

Since:

2014.2.0

startsWith

public static boolean startsWith(java.lang.String source,
                 java.lang.String prefix,
                 boolean caseSensitive)

Checks whether source string starts with prefix

Parameters:

source - The string

prefix - The string

caseSensitive - boolean

Returns:

True if source starts with prefix

Since:

2014.2.0

startsWithIgnoreCase

public static boolean startsWithIgnoreCase(java.lang.String source,
                           java.lang.String prefix)

Checks whether source string starts with prefix

Parameters:

source - The string

prefix - The string

Returns:

True if source starts with prefix

Since:

2014.2.0

toString

public static java.lang.String toString(java.lang.String value,
                        java.lang.String fallback)

Returns the string back if blank returns the fallback

Parameters:

value - The string

fallback - The string

Returns:

if string is blank returns the fallback

Since:

2015.2.0

defaultIfEmpty

public static java.lang.String defaultIfEmpty(java.lang.String value,
                              java.lang.String fallback)

Returns the string back if blank returns the fallback

Parameters:

value - The string

fallback - The string

Returns:

if string is blank returns the fallback

Since:

2016.1.0

next

public static java.lang.String next(java.util.Iterator<java.lang.String> itr,
                    java.lang.String fallback)

Returns the next string of the iterator

Parameters:

itr - The string Iterator

fallback - The string

Returns:

if not available returns the fallback

Since:

2016.2.0

next

public static java.lang.String next(java.util.Iterator<java.lang.String> itr)

Returns the next string of the iterator

Parameters:

itr - The string Iterator

Returns:

if not available returns null

Since:

2016.2.0

stripNonValidXMLCharacters

public static java.lang.String stripNonValidXMLCharacters(java.lang.String source)

This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard. For reference, please see the standard. This method will return null if the input is null.

Parameters:

source - The String whose non-valid characters we want to remove.

Returns:

The in String, stripped of non-valid characters.

Since:

2015.2.0

removeAllWhitespaces

public static java.lang.String removeAllWhitespaces(java.lang.String s)

Removes all whitespaces from a string.

For example, a string containing following text: (the whitespace is marked).

  A  TEXT         WITH    SOME SPACES   .
   ^    ^^^^^^^^^    ^^^^    ^      ^^^
 

Will after calling this method be: ATEXTWITHSOMESPACES. (No Whitespaces)

Parameters:

s - An input string

Returns:

The modified string.

Since:

2016.1.0

addWhitespaceBetweenCharacters

public static java.lang.String addWhitespaceBetweenCharacters(java.lang.String s)

Add whitespace between characters in a string

For example, a string containing following text: (the whitespace is marked).

  HELLO WOR   LD!
       ^   ^^^
 

Will after calling this method be: H E L L O W O R L D ! ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ (one Whitespace) If there is already a spaces between characters, only one whitespace will be kept.

Parameters:

s - An input string

Returns:

The modified string.

Since:

2016.1.0

removeBlanks

public static java.util.Collection<java.lang.String> removeBlanks(java.util.Collection<java.lang.String> input)

Removes blank strings from the given list and returns new list

Parameters:

input - The Collection

Returns:

list without blank strings

Since:

2016.3.0

isEmpty

public static boolean isEmpty(java.lang.String[] values)

Checks if a string array is empty (or null)

Parameters:

values - array of string

Returns:

True if the string array is null, or it is empty

Since:

2017.1.0