StringUtils (jipipe 5.1.3-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.utils.StringUtils

```
public class StringUtils
extends Object
```
Utilities for strings

Field Summary

Fields
Modifier and Type Field and Description

static char[] INVALID_FILESYSTEM_CHARACTERS

static char[] INVALID_JSONIFY_CHARACTERS

Fields
Modifier and Type	Field and Description
`static char[]`	`INVALID_FILESYSTEM_CHARACTERS`
`static char[]`	`INVALID_JSONIFY_CHARACTERS`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`compareVersions(String version1, String version2)` Compares two version strings.
`static String`	`convertGlobToRegex(String pattern)` Converts a standard POSIX Shell globbing pattern into a regular expression pattern.
`static String`	`createIconTextHTMLTable(String text, URL iconURL)` Creates an HTML table with an icon and text.
`static String`	`createIconTextHTMLTableElement(String text, URL iconURL)` Creates an HTML table with an icon and text.
`static String`	`createRightIconTextHTMLTable(String text, URL iconURL)` Same as createIconTextHTMLTable but the icon is on the right side
`static String`	`createRightIconTextHTMLTableElement(String text, URL iconURL)` Same as createIconTextHTMLTableElement but the icon is on the right side
`static String`	`formatDateTime(LocalDateTime dateTime)` A nice human-readable format
`static String`	`formatDuration(long durationMilliseconds)` Formats a duration in milliseconds to something readable
`static String`	`formatPluralS(int count, String labelSingular)`
`static String`	`formatSize(long size)`
`static String`	`generateRandomString(String characters, int length)` Generates a random string
`static String`	`getCleanedMenuPath(String menuPath)` Cleans a menu path string
`static boolean`	`isFilesystemCompatible(String string)` Returns if the string does not contain invalid characters.
`static boolean`	`isNullOrEmpty(Object string)` Returns true if the string is null or empty
`static boolean`	`isValidDouble(String text)`
`static boolean`	`isValidInteger(String text)`
`static boolean`	`isValidVersion(String version)`
`static String`	`jsonify(String input)` Removes all spaces, and filesystem-unsafe characters from the string and replaces them with dashes Duplicate dashes are removed
`static String`	`limitWithEllipsis(String str, int maxWidth, FontMetrics metrics)` If the string is longer than maxWidth, limit it to fit within maxWidth with an ellipsis (...).
`static String`	`limitWithoutEllipsis(String str, int maxWidth, FontMetrics metrics)` If the string is longer than maxWidth, limit it to fit within maxWidth with an ellipsis (...).
`static String`	`makeFilesystemCompatible(String input)` Replaces all characters invalid for filesystems with spaces Assumes that the string is a filename, so path operators are not allowed.
`static String`	`makeUniqueString(String input, String spaceCharacter, Collection<String> existing)` Makes an unique string by adding a counting variable to its end if it already exists
`static String`	`makeUniqueString(String input, String spaceCharacter, Predicate<String> existing)` Makes an unique string by adding a counting variable to its end if it already exists
`static String`	`nullTerminate(String input)` Applies a \0 termination to a string.
`static String`	`nullToEmpty(Object s)` Returns an empty string if s is null otherwise returns s
`static double`	`objectToDouble(Object o)`
`static String`	`orElse(Object string, String ifNullOrEmpty)` Returns the string if its not null or empty or the alternative
`static double`	`parseDouble(String str)`
`static float`	`parseFloat(String str)`
`static int`	`parseInt(String str)`
`static String`	`removeDuplicateDelimiters(String string, String delimiter)`
`static String`	`removeHTMLRoot(String html)` Removes the HTML root from HTML
`static String`	`safeJsonify(String input)` Removes all spaces, and filesystem-unsafe characters from the string and replaces them with dashes Duplicate dashes are removed
`static String[]`	`splitNonRegex(String s, String delimiter)`
`static double`	`tryParseDouble(String str, double defaultValue)`
`static Object`	`tryParseDoubleOrReturnString(String str)` Attempts to parse a string as double.
`static String`	`wordWrappedHTML(String text, int wrapColumn)` Create word wrapping in HTML.
`static String`	`wordWrappedHTMLElement(String text, int wrapColumn)` Create word wrapping in HTML.
`static String`	`wrapHtml(String text)`

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

- Field Detail
  - INVALID_FILESYSTEM_CHARACTERS
```
public static final char[] INVALID_FILESYSTEM_CHARACTERS
```
  - INVALID_JSONIFY_CHARACTERS
```
public static final char[] INVALID_JSONIFY_CHARACTERS
```
- Method Detail
  - isValidDouble
```
public static boolean isValidDouble(String text)
```
  - isValidInteger
```
public static boolean isValidInteger(String text)
```
  - formatPluralS
```
public static String formatPluralS(int count,
                                   String labelSingular)
```
  - limitWithEllipsis
```
public static String limitWithEllipsis(String str,
                                       int maxWidth,
                                       FontMetrics metrics)
```
    If the string is longer than maxWidth, limit it to fit within maxWidth with an ellipsis (...). Will always return at least the string "..."
  - limitWithoutEllipsis
```
public static String limitWithoutEllipsis(String str,
                                          int maxWidth,
                                          FontMetrics metrics)
```
    If the string is longer than maxWidth, limit it to fit within maxWidth with an ellipsis (...). Will always return at least the string "..."
  - removeDuplicateDelimiters
```
public static String removeDuplicateDelimiters(String string,
                                               String delimiter)
```
  - formatDuration
```
public static String formatDuration(long durationMilliseconds)
```
    Formats a duration in milliseconds to something readable
    
    Parameters:
    
    durationMilliseconds - the duration
    
    Returns:
    
    formatted string
  - formatDateTime
```
public static String formatDateTime(LocalDateTime dateTime)
```
    A nice human-readable format
    
    Parameters:
    
    dateTime - the time point
    
    Returns:
    
    formatted string
  - createIconTextHTMLTable
```
public static String createIconTextHTMLTable(String text,
                                             URL iconURL)
```
    Creates an HTML table with an icon and text. Contains root elements.
    
    Parameters:
    
    text - the text. Is automatically escaped
    
    iconURL - the icon
    
    Returns:
    
    the HTML
  - createIconTextHTMLTableElement
```
public static String createIconTextHTMLTableElement(String text,
                                                    URL iconURL)
```
    Creates an HTML table with an icon and text. Has no HTML root
    
    Parameters:
    
    text - the text. Is automatically escaped
    
    iconURL - the icon
    
    Returns:
    
    the HTML element
  - createRightIconTextHTMLTable
```
public static String createRightIconTextHTMLTable(String text,
                                                  URL iconURL)
```
    Same as createIconTextHTMLTable but the icon is on the right side
    
    Parameters:
    
    text - the text. Is automatically escaped
    
    iconURL - the icon
    
    Returns:
    
    the HTML
  - createRightIconTextHTMLTableElement
```
public static String createRightIconTextHTMLTableElement(String text,
                                                         URL iconURL)
```
    Same as createIconTextHTMLTableElement but the icon is on the right side
    
    Parameters:
    
    text - the text. Is automatically escaped
    
    iconURL - the icon
    
    Returns:
    
    the HTML
  - nullTerminate
```
public static String nullTerminate(String input)
```
    Applies a \0 termination to a string. Used to parse unclean input from C
    
    Parameters:
    
    input - the input string
    
    Returns:
    
    string that ends at the first \0
  - removeHTMLRoot
```
public static String removeHTMLRoot(String html)
```
    Removes the HTML root from HTML
    
    Parameters:
    
    html - the HTML
    
    Returns:
    
    html without root
  - wordWrappedHTML
```
public static String wordWrappedHTML(String text,
                                     int wrapColumn)
```
    Create word wrapping in HTML. Has HTML root element.
    
    Parameters:
    
    text - the wrapped text. It is automatically escaped
    
    wrapColumn - after how many columns to break words
    
    Returns:
    
    the wrapped text
  - generateRandomString
```
public static String generateRandomString(String characters,
                                          int length)
```
    Generates a random string
    
    Parameters:
    
    characters - the available characters
    
    length - the length
    
    Returns:
    
    the string
  - wordWrappedHTMLElement
```
public static String wordWrappedHTMLElement(String text,
                                            int wrapColumn)
```
    Create word wrapping in HTML. Has HTML root element.
    
    Parameters:
    
    text - the wrapped text. It is automatically escaped
    
    wrapColumn - after how many columns to break words
    
    Returns:
    
    the wrapped text
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(Object string)
```
    Returns true if the string is null or empty
    
    Parameters:
    
    string - the string
    
    Returns:
    
    if the string is null or empty
  - orElse
```
public static String orElse(Object string,
                            String ifNullOrEmpty)
```
    Returns the string if its not null or empty or the alternative
    
    Parameters:
    
    string - the string
    
    ifNullOrEmpty - returned if string is null or empty
    
    Returns:
    
    string or ifNullOrEmpty depending on if string is null or empty
  - safeJsonify
```
public static String safeJsonify(String input)
```
    Removes all spaces, and filesystem-unsafe characters from the string and replaces them with dashes Duplicate dashes are removed
    
    Parameters:
    
    input - the input string
    
    Returns:
    
    jsonified string
  - jsonify
```
public static String jsonify(String input)
```
    Removes all spaces, and filesystem-unsafe characters from the string and replaces them with dashes Duplicate dashes are removed
    
    Parameters:
    
    input - the input string
    
    Returns:
    
    jsonified string
  - makeFilesystemCompatible
```
public static String makeFilesystemCompatible(String input)
```
    Replaces all characters invalid for filesystems with spaces Assumes that the string is a filename, so path operators are not allowed. Applies the limits for file / path names
    
    Parameters:
    
    input - filename
    
    Returns:
    
    string compatible with file systems
  - makeUniqueString
```
public static String makeUniqueString(String input,
                                      String spaceCharacter,
                                      Collection<String> existing)
```
    Makes an unique string by adding a counting variable to its end if it already exists
    
    Parameters:
    
    input - initial string
    
    spaceCharacter - character to add between the string and counting variable
    
    existing - collection of existing strings
    
    Returns:
    
    unique string
  - makeUniqueString
```
public static String makeUniqueString(String input,
                                      String spaceCharacter,
                                      Predicate<String> existing)
```
    Makes an unique string by adding a counting variable to its end if it already exists
    
    Parameters:
    
    input - initial string
    
    spaceCharacter - character to add between the string and counting variable
    
    existing - function that returns true if the string already exists
    
    Returns:
    
    unique string
  - getCleanedMenuPath
```
public static String getCleanedMenuPath(String menuPath)
```
    Cleans a menu path string
    
    Parameters:
    
    menuPath - a menu path
    
    Returns:
    
    cleaned string
  - isFilesystemCompatible
```
public static boolean isFilesystemCompatible(String string)
```
    Returns if the string does not contain invalid characters. Assumes that the string is a filename, so path operators are not allowed.
    
    Parameters:
    
    string - the filename
    
    Returns:
    
    if the filename is valid
  - nullToEmpty
```
public static String nullToEmpty(Object s)
```
    Returns an empty string if s is null otherwise returns s
    
    Parameters:
    
    s - the string
    
    Returns:
    
    an empty string if s is null otherwise returns s
  - convertGlobToRegex
```
public static String convertGlobToRegex(String pattern)
```
    Converts a standard POSIX Shell globbing pattern into a regular expression pattern. The result can be used with the standard java.util.regex API to recognize strings which match the glob pattern.
    See also, the POSIX Shell language: ...
    See ...
    
    Parameters:
    
    pattern - A glob pattern.
    
    Returns:
    
    A regex pattern to recognize the given glob pattern.
  - compareVersions
```
public static int compareVersions(String version1,
                                  String version2)
```
    Compares two version strings. Only numeric versions are supported
    
    Parameters:
    
    version1 - the first version
    
    version2 - the second version
    
    Returns:
    
    -1 if version1 is less than version2. 1 if version2 is less than version1. 0 if equal
  - tryParseDoubleOrReturnString
```
public static Object tryParseDoubleOrReturnString(String str)
```
    Attempts to parse a string as double. If not successful, return the string
    
    Parameters:
    
    str - the string
    
    Returns:
    
    the number or the string
  - tryParseDouble
```
public static double tryParseDouble(String str,
                                    double defaultValue)
```
  - parseInt
```
public static int parseInt(String str)
```
  - parseDouble
```
public static double parseDouble(String str)
```
  - parseFloat
```
public static float parseFloat(String str)
```
  - objectToDouble
```
public static double objectToDouble(Object o)
```
  - isValidVersion
```
public static boolean isValidVersion(String version)
```
  - splitNonRegex
```
public static String[] splitNonRegex(String s,
                                     String delimiter)
```
  - wrapHtml
```
public static String wrapHtml(String text)
```
  - formatSize
```
public static String formatSize(long size)
```

Class StringUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_FILESYSTEM_CHARACTERS

INVALID_JSONIFY_CHARACTERS

Method Detail

isValidDouble

isValidInteger

formatPluralS

limitWithEllipsis

limitWithoutEllipsis

removeDuplicateDelimiters

formatDuration

formatDateTime

createIconTextHTMLTable

createIconTextHTMLTableElement

createRightIconTextHTMLTable

createRightIconTextHTMLTableElement

nullTerminate

removeHTMLRoot

wordWrappedHTML

generateRandomString

wordWrappedHTMLElement

isNullOrEmpty

orElse

safeJsonify

jsonify

makeFilesystemCompatible

makeUniqueString

makeUniqueString

getCleanedMenuPath

isFilesystemCompatible

nullToEmpty

convertGlobToRegex

compareVersions

tryParseDoubleOrReturnString

tryParseDouble

parseInt

parseDouble

parseFloat

objectToDouble

isValidVersion

splitNonRegex

wrapHtml

formatSize