StringUtils (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.utils.StringUtils

```
public class StringUtils
extends Object
```
Utils for BinaryString and utility class to convert objects into strings in vice-versa.

Field Summary

Fields
Modifier and Type Field and Description

static String EMPTY
The empty String "".

static int INDEX_NOT_FOUND
Represents a failed index search.

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY` The empty String `""`.
`static int`	`INDEX_NOT_FOUND` Represents a failed index search.

Constructor Summary

Constructors
Constructor and Description

StringUtils()

Constructors
Constructor and Description
`StringUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`bytesToBinaryString(byte[] bytes)` Given an array of bytes it will convert the bytes to a binary (0-1) string representation of the bytes.
`static String`	`byteToHexString(byte[] bytes)` Given an array of bytes it will convert the bytes to a hex string representation of the bytes.
`static String`	`byteToHexString(byte[] bytes, int start, int end)` Given an array of bytes it will convert the bytes to a hex string representation of the bytes.
`static String`	`caseSensitiveConversion(String str, boolean allowUpperCase)`
`static BinaryString`	`concat(BinaryString... inputs)` Concatenates input strings together into a single string.
`static BinaryString`	`concat(Iterable<BinaryString> inputs)`
`static String`	`getRandomString(Random rnd, int minLength, int maxLength)` Creates a random string with a length within the given interval.
`static String`	`getRandomString(Random rnd, int minLength, int maxLength, char minValue, char maxValue)` Creates a random string with a length within the given interval.
`static boolean`	`isEmpty(CharSequence cs)` Checks if a CharSequence is empty ("") or null.
`static boolean`	`isNullOrWhitespaceOnly(String str)` Checks if the string is null, empty, or contains only whitespace characters.
`static boolean`	`isNumeric(CharSequence cs)`
`static String`	`join(Iterable<?> iterable, String separator)` Joins the elements of the provided `Iterable` into a single String containing the provided elements.
`static String`	`join(Iterator<?> iterator, String separator)` Joins the elements of the provided `Iterator` into a single String containing the provided elements.
`static String`	`quote(String str)`
`static String`	`randomNumericString(int len)`
`static String`	`repeat(String string, int count)` Returns a string consisting of a specific number of concatenated copies of an input string.
`static String`	`replace(String text, String searchString, String replacement)` Replaces all occurrences of a String within another String.
`static String`	`replace(String text, String searchString, String replacement, int max)` Replaces a String with another String inside a larger String, for the first `max` values of the search String.
`static String[]`	`split(String str, String separatorChars)` Splits the provided text into an array, separators specified.
`static String[]`	`split(String str, String separatorChars, int max, boolean preserveAllTokens)` Performs the logic for the `split` and `splitPreserveAllTokens` methods that return a maximum array length.

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

- Field Detail
  - INDEX_NOT_FOUND
```
public static final int INDEX_NOT_FOUND
```
    Represents a failed index search.
    
    Since:
    
    2.1
    
    See Also:
    
    Constant Field Values
  - EMPTY
```
public static final String EMPTY
```
    The empty String "".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StringUtils
```
public StringUtils()
```
- Method Detail
  - concat
```
public static BinaryString concat(BinaryString... inputs)
```
    Concatenates input strings together into a single string. Returns NULL if any argument is NULL.
  - concat
```
public static BinaryString concat(Iterable<BinaryString> inputs)
```
  - isNullOrWhitespaceOnly
```
public static boolean isNullOrWhitespaceOnly(String str)
```
    Checks if the string is null, empty, or contains only whitespace characters. A whitespace character is defined via Character.isWhitespace(char).
    
    Parameters:
    
    str - The string to check
    
    Returns:
    
    True, if the string is null or blank, false otherwise.
  - byteToHexString
```
public static String byteToHexString(byte[] bytes,
                                     int start,
                                     int end)
```
    Given an array of bytes it will convert the bytes to a hex string representation of the bytes.
    
    Parameters:
    
    bytes - the bytes to convert in a hex string
    
    start - start index, inclusively
    
    end - end index, exclusively
    
    Returns:
    
    hex string representation of the byte array
  - byteToHexString
```
public static String byteToHexString(byte[] bytes)
```
    Given an array of bytes it will convert the bytes to a hex string representation of the bytes.
    
    Parameters:
    
    bytes - the bytes to convert in a hex string
    
    Returns:
    
    hex string representation of the byte array
  - bytesToBinaryString
```
public static String bytesToBinaryString(byte[] bytes)
```
    Given an array of bytes it will convert the bytes to a binary (0-1) string representation of the bytes.
    
    Parameters:
    
    bytes - the bytes to be converted
    
    Returns:
    
    binary string representation of the byte array
  - getRandomString
```
public static String getRandomString(Random rnd,
                                     int minLength,
                                     int maxLength)
```
    Creates a random string with a length within the given interval. The string contains only characters that can be represented as a single code point.
    
    Parameters:
    
    rnd - The random used to create the strings.
    
    minLength - The minimum string length.
    
    maxLength - The maximum string length (inclusive).
    
    Returns:
    
    A random String.
  - getRandomString
```
public static String getRandomString(Random rnd,
                                     int minLength,
                                     int maxLength,
                                     char minValue,
                                     char maxValue)
```
    Creates a random string with a length within the given interval. The string contains only characters that can be represented as a single code point.
    
    Parameters:
    
    rnd - The random used to create the strings.
    
    minLength - The minimum string length.
    
    maxLength - The maximum string length (inclusive).
    
    minValue - The minimum character value to occur.
    
    maxValue - The maximum character value to occur.
    
    Returns:
    
    A random String.
  - repeat
```
public static String repeat(String string,
                            int count)
```
    Returns a string consisting of a specific number of concatenated copies of an input string. For example, repeat("hey", 3) returns the string "heyheyhey".
    
    Parameters:
    
    string - any non-null string
    
    count - the number of times to repeat it; a nonnegative integer
    
    Returns:
    
    a string containing string repeated count times (the empty string if count is zero)
    
    Throws:
    
    IllegalArgumentException - if count is negative
  - replace
```
public static String replace(String text,
                             String searchString,
                             String replacement)
```
    Replaces all occurrences of a String within another String.
    A null reference passed to this method is a no-op.
```
 StringUtils.replace(null, *, *)        = null
 StringUtils.replace("", *, *)          = ""
 StringUtils.replace("any", null, *)    = "any"
 StringUtils.replace("any", *, null)    = "any"
 StringUtils.replace("any", "", *)      = "any"
 StringUtils.replace("aba", "a", null)  = "aba"
 StringUtils.replace("aba", "a", "")    = "b"
 StringUtils.replace("aba", "a", "z")   = "zbz"
 
```
    Parameters:
    
    text - text to search and replace in, may be null
    
    searchString - the String to search for, may be null
    
    replacement - the String to replace it with, may be null
    
    Returns:
    
    the text with any replacements processed, null if null String input
    
    See Also:
    
    replace(String text, String searchString, String replacement, int max)
  - replace
```
public static String replace(String text,
                             String searchString,
                             String replacement,
                             int max)
```
    Replaces a String with another String inside a larger String, for the first max values of the search String.
    A null reference passed to this method is a no-op.
```
 StringUtils.replace(null, *, *, *)         = null
 StringUtils.replace("", *, *, *)           = ""
 StringUtils.replace("any", null, *, *)     = "any"
 StringUtils.replace("any", *, null, *)     = "any"
 StringUtils.replace("any", "", *, *)       = "any"
 StringUtils.replace("any", *, *, 0)        = "any"
 StringUtils.replace("abaa", "a", null, -1) = "abaa"
 StringUtils.replace("abaa", "a", "", -1)   = "b"
 StringUtils.replace("abaa", "a", "z", 0)   = "abaa"
 StringUtils.replace("abaa", "a", "z", 1)   = "zbaa"
 StringUtils.replace("abaa", "a", "z", 2)   = "zbza"
 StringUtils.replace("abaa", "a", "z", -1)  = "zbzz"
 
```
    Parameters:
    
    text - text to search and replace in, may be null
    
    searchString - the String to search for, may be null
    
    replacement - the String to replace it with, may be null
    
    max - maximum number of values to replace, or -1 if no maximum
    
    Returns:
    
    the text with any replacements processed, null if null String input
  - isEmpty
```
public static boolean isEmpty(CharSequence cs)
```
    Checks if a CharSequence is empty ("") or null.
```
 StringUtils.isEmpty(null)      = true
 StringUtils.isEmpty("")        = true
 StringUtils.isEmpty(" ")       = false
 StringUtils.isEmpty("bob")     = false
 StringUtils.isEmpty("  bob  ") = false
 
```
    NOTE: This method changed in Lang version 2.0. It no longer trims the CharSequence. That functionality is available in isNullOrWhitespaceOnly().
    Parameters:
    
    cs - the CharSequence to check, may be null
    
    Returns:
    
    true if the CharSequence is empty or null
    
    Since:
    
    3.0 Changed signature from isEmpty(String) to isEmpty(CharSequence)
  - randomNumericString
```
public static String randomNumericString(int len)
```
  - split
```
public static String[] split(String str,
                             String separatorChars)
```
    Splits the provided text into an array, separators specified. This is an alternative to using StringTokenizer.
    The separator is not included in the returned String array. Adjacent separators are treated as one separator. For more control over the split use the StrTokenizer class.
    A null input String returns null. A null separatorChars splits on whitespace.
```
 StringUtils.split(null, *)         = null
 StringUtils.split("", *)           = []
 StringUtils.split("abc def", null) = ["abc", "def"]
 StringUtils.split("abc def", " ")  = ["abc", "def"]
 StringUtils.split("abc  def", " ") = ["abc", "def"]
 StringUtils.split("ab:cd:ef", ":") = ["ab", "cd", "ef"]
 
```
    Parameters:
    
    str - the String to parse, may be null
    
    separatorChars - the characters used as the delimiters, null splits on whitespace
    
    Returns:
    
    an array of parsed Strings, null if null String input
  - split
```
public static String[] split(String str,
                             String separatorChars,
                             int max,
                             boolean preserveAllTokens)
```
    Performs the logic for the split and splitPreserveAllTokens methods that return a maximum array length.
    
    Parameters:
    
    str - the String to parse, may be null
    
    separatorChars - the separate character
    
    max - the maximum number of elements to include in the array. A zero or negative value implies no limit.
    
    preserveAllTokens - if true, adjacent separators are treated as empty token separators; if false, adjacent separators are treated as one separator.
    
    Returns:
    
    an array of parsed Strings, null if null String input
  - join
```
public static String join(Iterable<?> iterable,
                          String separator)
```
    Joins the elements of the provided Iterable into a single String containing the provided elements.
    No delimiter is added before or after the list. A null separator is the same as an empty String ("").
    
    Parameters:
    
    iterable - the Iterable providing the values to join together, may be null
    
    separator - the separator character to use, null treated as ""
    
    Returns:
    
    the joined String, null if null iterator input
  - join
```
public static String join(Iterator<?> iterator,
                          String separator)
```
    Joins the elements of the provided Iterator into a single String containing the provided elements.
    No delimiter is added before or after the list. A null separator is the same as an empty String ("").
    
    Parameters:
    
    iterator - the Iterator of values to join together, may be null
    
    separator - the separator character to use, null treated as ""
    
    Returns:
    
    the joined String, null if null iterator input
  - quote
```
public static String quote(String str)
```
  - caseSensitiveConversion
```
public static String caseSensitiveConversion(String str,
                                             boolean allowUpperCase)
```
  - isNumeric
```
public static boolean isNumeric(CharSequence cs)
```

Back to Paimon Website

Class StringUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDEX_NOT_FOUND

EMPTY

Constructor Detail

StringUtils

Method Detail

concat

concat

isNullOrWhitespaceOnly

byteToHexString

byteToHexString

bytesToBinaryString

getRandomString

getRandomString

repeat

replace

replace

isEmpty

randomNumericString

split

split

join

join

quote

caseSensitiveConversion

isNumeric

Back to Paimon Website