public class Strings extends Object
Modifier and Type | Field and Description |
---|---|
static String[] |
EMPTY_ARRAY |
static com.google.common.collect.ImmutableSet<Character> |
INVALID_FILENAME_CHARS |
Modifier and Type | Method and Description |
---|---|
static String |
arrayToCommaDelimitedString(Object[] arr)
Convenience method to return a String array as a CSV String.
|
static String |
arrayToDelimitedString(Object[] arr,
String delim)
Convenience method to return a String array as a delimited (e.g.
|
static String |
arrayToDelimitedString(Object[] arr,
String delim,
StringBuilder sb) |
static String |
base64UUID()
Generates a time-based UUID (similar to Flake IDs), which is preferred when generating an ID to be indexed into a Lucene index as
primary key.
|
static String |
capitalize(String str)
Capitalize a
String , changing the first letter to
upper case as per Character.toUpperCase(char) . |
static String |
cleanPath(String path)
Normalize the path by suppressing sequences like "path/.." and
inner simple dots.
|
static String |
cleanTruncate(String s,
int length)
Truncates string to a length less than length.
|
static String |
coalesceToEmpty(String s) |
static String |
collectionToCommaDelimitedString(Iterable<?> coll)
Convenience method to return a Collection as a CSV String.
|
static String |
collectionToDelimitedString(Iterable<?> coll,
String delim)
Convenience method to return a Collection as a delimited (e.g.
|
static String |
collectionToDelimitedString(Iterable<?> coll,
String delim,
String prefix,
String suffix)
Convenience method to return a Collection as a delimited (e.g.
|
static String |
collectionToDelimitedString(Iterable<?> coll,
String delim,
String prefix,
String suffix,
StringBuilder sb) |
static Set<String> |
commaDelimitedListToSet(String str)
Convenience method to convert a CSV string list to a set.
|
static String[] |
commaDelimitedListToStringArray(String str)
Convert a CSV list into an array of Strings.
|
static boolean |
containsWhitespace(CharSequence str)
Check whether the given CharSequence contains any whitespace characters.
|
static int |
countOccurrencesOf(String str,
String sub)
Count the occurrences of the substring in string s.
|
static String |
delete(String inString,
String pattern)
Delete all occurrences of the given substring.
|
static String |
deleteAny(String inString,
String charsToDelete)
Delete any character in a given String.
|
static String[] |
delimitedListToStringArray(String str,
String delimiter)
Take a String which is a delimited list and convert it to a String array.
|
static String[] |
delimitedListToStringArray(String str,
String delimiter,
String charsToDelete)
Take a String which is a delimited list and convert it to a String array.
|
static String |
format1Decimals(double value,
String suffix)
Format the double value with a single decimal points, trimming trailing '.0'.
|
static boolean |
hasLength(BytesReference bytesReference)
Check that the given BytesReference is neither
null nor of length 0
Note: Will return true for a BytesReference that purely consists of whitespace. |
static boolean |
hasLength(CharSequence str)
Check that the given CharSequence is neither
null nor of length 0. |
static boolean |
hasLength(String str)
Check that the given String is neither
null nor of length 0. |
static boolean |
hasText(CharSequence str)
Check whether the given CharSequence has actual text.
|
static boolean |
hasText(String str)
Check whether the given String has actual text.
|
static boolean |
isAllOrWildcard(String[] data)
If an array only consists of zero or one element, which is "*" or "_all" return an empty array
which is usually used as everything
|
static boolean |
isEmpty(CharSequence str)
Check that the given CharSequence is either
null or of length 0. |
static boolean |
isNullOrEmpty(String s) |
static String |
padStart(String s,
int minimumLength,
char c) |
static String |
quote(String str)
Quote the given String with single quotes.
|
static String |
randomBase64UUID()
Returns a Base64 encoded version of a Version 4.0 compatible UUID as defined here: http://www.ietf.org/rfc/rfc4122.txt, using a
private
SecureRandom instance |
static String |
randomBase64UUID(Random random)
Returns a Base64 encoded version of a Version 4.0 compatible UUID as defined here: http://www.ietf.org/rfc/rfc4122.txt, using the
provided
Random instance |
static String |
replace(String inString,
String oldPattern,
String newPattern)
Replace all occurrences of a substring within a string with
another string.
|
static void |
spaceify(int spaces,
String from,
StringBuilder to) |
static String[] |
split(String toSplit,
String delimiter)
Split a String at the first occurrence of the delimiter.
|
static Properties |
splitArrayElementsIntoProperties(String[] array,
String delimiter,
String charsToDelete)
Take an array Strings and split each element based on the given delimiter.
|
static List<String> |
splitSmart(String s,
String separator,
boolean decode)
Splits a backslash escaped string on the separator.
|
static String[] |
splitStringByCommaToArray(String s) |
static Set<String> |
splitStringByCommaToSet(String s) |
static String[] |
splitStringToArray(CharSequence s,
char c) |
static Set<String> |
splitStringToSet(String s,
char c) |
static String |
substring(String s,
int beginIndex,
int endIndex)
Return substring(beginIndex, endIndex) that is impervious to string length.
|
static boolean |
substringMatch(CharSequence str,
int index,
CharSequence substring)
Test whether the given string matches the given substring
at the given index.
|
static String |
toCamelCase(String value) |
static String |
toCamelCase(String value,
StringBuilder sb) |
static String[] |
tokenizeToStringArray(String str,
String delimiters)
Tokenize the given String into a String array via a StringTokenizer.
|
static String[] |
tokenizeToStringArray(String str,
String delimiters,
boolean trimTokens,
boolean ignoreEmptyTokens)
Tokenize the given String into a String array via a StringTokenizer.
|
static String |
toString(ToXContent toXContent)
Return a
String that is the json representation of the provided
ToXContent . |
static String |
toString(ToXContent toXContent,
boolean wrapInObject)
Return a
String that is the json representation of the provided
ToXContent . |
static String[] |
toStringArray(Collection<String> collection)
Copy the given Collection into a String array.
|
static String |
toUnderscoreCase(String value) |
static String |
toUnderscoreCase(String value,
StringBuilder sb) |
static byte[] |
toUTF8Bytes(CharSequence charSequence) |
static byte[] |
toUTF8Bytes(CharSequence charSequence,
org.apache.lucene.util.BytesRefBuilder spare) |
static String |
trimLeadingCharacter(String str,
char leadingCharacter)
Trim all occurrences of the supplied leading character from the given String.
|
static String |
trimLeadingWhitespace(String str)
Trim leading whitespace from the given String.
|
static String |
unqualify(String qualifiedName,
char separator)
Unqualify a string qualified by a separator character.
|
static boolean |
validFileName(String fileName) |
static boolean |
validFileNameExcludingAstrix(String fileName) |
public static final String[] EMPTY_ARRAY
public static final com.google.common.collect.ImmutableSet<Character> INVALID_FILENAME_CHARS
public static void spaceify(int spaces, String from, StringBuilder to) throws Exception
Exception
public static List<String> splitSmart(String s, String separator, boolean decode)
Current backslash escaping supported:
\n \t \r \b \f are escaped the same as a Java String
Other characters following a backslash are produced verbatim (\c => c)
s
- the string to splitseparator
- the separator to split ondecode
- decode backslash escapingpublic static boolean hasLength(CharSequence str)
null
nor of length 0.
Note: Will return true
for a CharSequence that purely consists of whitespace.
StringUtils.hasLength(null) = false StringUtils.hasLength("") = false StringUtils.hasLength(" ") = true StringUtils.hasLength("Hello") = true
str
- the CharSequence to check (may be null
)true
if the CharSequence is not null and has lengthhasText(String)
public static boolean hasLength(BytesReference bytesReference)
null
nor of length 0
Note: Will return true
for a BytesReference that purely consists of whitespace.bytesReference
- the BytesReference to check (may be null
)true
if the BytesReference is not null and has lengthhasLength(CharSequence)
public static boolean hasLength(String str)
null
nor of length 0.
Note: Will return true
for a String that purely consists of whitespace.str
- the String to check (may be null
)true
if the String is not null and has lengthhasLength(CharSequence)
public static boolean isEmpty(CharSequence str)
null
or of length 0.
Note: Will return false
for a CharSequence that purely consists of whitespace.
StringUtils.isEmpty(null) = true StringUtils.isEmpty("") = true StringUtils.isEmpty(" ") = false StringUtils.isEmpty("Hello") = false
str
- the CharSequence to check (may be null
)true
if the CharSequence is either null or has a zero lengthpublic static boolean hasText(CharSequence str)
true
if the string not null
,
its length is greater than 0, and it contains at least one non-whitespace character.
StringUtils.hasText(null) = false StringUtils.hasText("") = false StringUtils.hasText(" ") = false StringUtils.hasText("12345") = true StringUtils.hasText(" 12345 ") = true
str
- the CharSequence to check (may be null
)true
if the CharSequence is not null
,
its length is greater than 0, and it does not contain whitespace onlyCharacter.isWhitespace(char)
public static boolean hasText(String str)
true
if the string not null
,
its length is greater than 0, and it contains at least one non-whitespace character.str
- the String to check (may be null
)true
if the String is not null
, its length is
greater than 0, and it does not contain whitespace onlyhasText(CharSequence)
public static boolean containsWhitespace(CharSequence str)
str
- the CharSequence to check (may be null
)true
if the CharSequence is not empty and
contains at least 1 whitespace characterCharacter.isWhitespace(char)
public static String trimLeadingWhitespace(String str)
str
- the String to checkCharacter.isWhitespace(char)
public static String trimLeadingCharacter(String str, char leadingCharacter)
str
- the String to checkleadingCharacter
- the leading character to be trimmedpublic static boolean substringMatch(CharSequence str, int index, CharSequence substring)
str
- the original string (or StringBuilder)index
- the index in the original string to start matching againstsubstring
- the substring to match at the given indexpublic static int countOccurrencesOf(String str, String sub)
str
- string to search in. Return 0 if this is null.sub
- string to search for. Return 0 if this is null.public static String replace(String inString, String oldPattern, String newPattern)
inString
- String to examineoldPattern
- String to replacenewPattern
- String to insertpublic static String delete(String inString, String pattern)
inString
- the original Stringpattern
- the pattern to delete all occurrences ofpublic static String deleteAny(String inString, String charsToDelete)
inString
- the original StringcharsToDelete
- a set of characters to delete.
E.g. "az\n" will delete 'a's, 'z's and new lines.public static String quote(String str)
str
- the input String (e.g. "myString")null
if the input was null
public static String unqualify(String qualifiedName, char separator)
qualifiedName
- the qualified nameseparator
- the separatorpublic static String capitalize(String str)
String
, changing the first letter to
upper case as per Character.toUpperCase(char)
.
No other letters are changed.str
- the String to capitalize, may be null
null
if nullpublic static boolean validFileName(String fileName)
public static boolean validFileNameExcludingAstrix(String fileName)
public static String cleanPath(String path)
The result is convenient for path comparison. For other uses, notice that Windows separators ("\") are replaced by simple slashes.
path
- the original pathpublic static String[] toStringArray(Collection<String> collection)
collection
- the Collection to copynull
if the passed-in
Collection was null
)public static String[] splitStringToArray(CharSequence s, char c)
public static String[] split(String toSplit, String delimiter)
toSplit
- the string to splitdelimiter
- to split the string up withnull
if the delimiter wasn't found in the given input Stringpublic static Properties splitArrayElementsIntoProperties(String[] array, String delimiter, String charsToDelete)
Properties
instance is then generated, with the left of the
delimiter providing the key, and the right of the delimiter providing the value.
Will trim both the key and value before adding them to the
Properties
instance.
array
- the array to processdelimiter
- to split each element using (typically the equals symbol)charsToDelete
- one or more characters to remove from each element
prior to attempting the split operation (typically the quotation mark
symbol), or null
if no removal should occurProperties
instance representing the array contents,
or null
if the array to process was null
or emptypublic static String[] tokenizeToStringArray(String str, String delimiters)
The given delimiters string is supposed to consist of any number of
delimiter characters. Each of those characters can be used to separate
tokens. A delimiter is always a single character; for multi-character
delimiters, consider using delimitedListToStringArray
str
- the String to tokenizedelimiters
- the delimiter characters, assembled as String
(each of those characters is individually considered as delimiter).StringTokenizer
,
String.trim()
,
delimitedListToStringArray(java.lang.String, java.lang.String)
public static String[] tokenizeToStringArray(String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens)
The given delimiters string is supposed to consist of any number of
delimiter characters. Each of those characters can be used to separate
tokens. A delimiter is always a single character; for multi-character
delimiters, consider using delimitedListToStringArray
str
- the String to tokenizedelimiters
- the delimiter characters, assembled as String
(each of those characters is individually considered as delimiter)trimTokens
- trim the tokens via String's trim
ignoreEmptyTokens
- omit empty tokens from the result array
(only applies to tokens that are empty after trimming; StringTokenizer
will not consider subsequent delimiters as token in the first place).null
if the input String
was null
)StringTokenizer
,
String.trim()
,
delimitedListToStringArray(java.lang.String, java.lang.String)
public static String[] delimitedListToStringArray(String str, String delimiter)
A single delimiter can consists of more than one character: It will still
be considered as single delimiter string, rather than as bunch of potential
delimiter characters - in contrast to tokenizeToStringArray
.
str
- the input Stringdelimiter
- the delimiter between elements (this is a single delimiter,
rather than a bunch individual delimiter characters)tokenizeToStringArray(java.lang.String, java.lang.String)
public static String[] delimitedListToStringArray(String str, String delimiter, String charsToDelete)
A single delimiter can consists of more than one character: It will still
be considered as single delimiter string, rather than as bunch of potential
delimiter characters - in contrast to tokenizeToStringArray
.
str
- the input Stringdelimiter
- the delimiter between elements (this is a single delimiter,
rather than a bunch individual delimiter characters)charsToDelete
- a set of characters to delete. Useful for deleting unwanted
line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String.tokenizeToStringArray(java.lang.String, java.lang.String)
public static String[] commaDelimitedListToStringArray(String str)
str
- the input Stringpublic static Set<String> commaDelimitedListToSet(String str)
str
- the input Stringpublic static String collectionToDelimitedString(Iterable<?> coll, String delim, String prefix, String suffix)
toString()
implementations.coll
- the Collection to displaydelim
- the delimiter to use (probably a ",")prefix
- the String to start each element withsuffix
- the String to end each element withpublic static String collectionToDelimitedString(Iterable<?> coll, String delim, String prefix, String suffix, StringBuilder sb)
public static String collectionToDelimitedString(Iterable<?> coll, String delim)
toString()
implementations.coll
- the Collection to displaydelim
- the delimiter to use (probably a ",")public static String collectionToCommaDelimitedString(Iterable<?> coll)
toString()
implementations.coll
- the Collection to displaypublic static String arrayToDelimitedString(Object[] arr, String delim)
toString()
implementations.arr
- the array to displaydelim
- the delimiter to use (probably a ",")public static String arrayToDelimitedString(Object[] arr, String delim, StringBuilder sb)
public static String arrayToCommaDelimitedString(Object[] arr)
toString()
implementations.arr
- the array to displaypublic static String format1Decimals(double value, String suffix)
public static String toCamelCase(String value, StringBuilder sb)
public static String toUnderscoreCase(String value, StringBuilder sb)
public static byte[] toUTF8Bytes(CharSequence charSequence)
public static byte[] toUTF8Bytes(CharSequence charSequence, org.apache.lucene.util.BytesRefBuilder spare)
public static String substring(String s, int beginIndex, int endIndex)
public static boolean isAllOrWildcard(String[] data)
public static String randomBase64UUID()
SecureRandom
instancepublic static String randomBase64UUID(Random random)
Random
instancepublic static String base64UUID()
public static String toString(ToXContent toXContent)
String
that is the json representation of the provided
ToXContent
.public static String toString(ToXContent toXContent, boolean wrapInObject)
String
that is the json representation of the provided
ToXContent
.wrapInObject
- set this to true if the ToXContent instance expects to be inside an objectpublic static String cleanTruncate(String s, int length)
Copyright © 2009–2017. All rights reserved.