com.alee.utils

Class TextUtils

java.lang.Object

com.alee.utils.TextUtils

public final class TextUtils
extends Object

This class provides a set of utilities to work with various text usage cases.

Author:

Mikle Garin

Method Summary

Modifier and Type	Method and Description
static <T> String	arrayToString(String separator, Function<T,String> textProvider, Filter<T> filter, T... array) Returns single text combined from array of elements using specified separator.
static <T> String	arrayToString(String separator, Function<T,String> textProvider, T... array) Returns single text combined from array of elements using specified separator.
static <T> String	arrayToString(String separator, T... array) Returns single text combined from array of elements using specified separator.
static <T> String	arrayToString(T... array) Returns single text combined from array of elements using default separator.
static <T> String	collectionToString(Collection<T> collection) Returns single text combined from Collection of elements using default separator.
static <T> String	collectionToString(Collection<T> collection, String separator) Returns single text combined from Collection of elements using specified separator.
static <T> String	collectionToString(Collection<T> collection, String separator, Function<T,String> textProvider) Returns single text combined from Collection of elements using specified separator.
static <T> String	collectionToString(Collection<T> collection, String separator, Function<T,String> textProvider, Filter<T> filter) Returns single text combined from Collection of elements using specified separator.
static String	createString(char character, int length) Creates new string filled with specified amount of same characters.
static String	createString(String character, int length) Creates new string filled with specified amount of same characters.
static <E extends Enum<E>> String	enumArrayToString(E... enumArray) Converts array of enumeration constants into string with list of enumeration constants and returns it.
static <E extends Enum<E>> String	enumArrayToString(String separator, E... enumArray) Converts array of enumeration constants into string with list of enumeration constants and returns it.
static <E extends Enum<E>> String	enumListToString(List<E> enumList) Converts list of enumeration constants into string with list of enumeration constants and returns it.
static <E extends Enum<E>> String	enumListToString(List<E> enumList, String separator) Converts list of enumeration constants into string with list of enumeration constants and returns it.
static <E extends Enum<E>> List<E>	enumStringToList(String enumString, Class<E> enumClass) Converts string with list of enumeration constants into real list of enumeration constants and returns it.
static <E extends Enum<E>> List<E>	enumStringToList(String enumString, Class<E> enumClass, String separator) Converts string with list of enumeration constants into real list of enumeration constants and returns it.
static boolean	equals(String string, String compareWith) Returns whether the first String equals to second one.
static boolean	equalsIgnoreCase(String string, String compareWith) Returns whether the first String equals to second one ignoring case.
static Integer	findFirstNumber(String text) Returns first number found in text.
static int	findFirstRowWordEndIndex(String string) Returns last index of the first word end.
static int	findFirstWordFromIndex(String string, int from) Returns begin index of first word after specified index.
static int	findLastRowWordStartIndex(String string) Returns begin index of last word in the specified text.
static String	format(String text, Object... objects) Returns message formatted with common string representations of the provided objects.
static String	generateId() Returns random ID with default prefix and suffix.
static String	generateId(int length) Returns randomly generated ID part with specified length.
static String	generateId(String prefix) Returns random ID with specified prefix and default suffix.
static String	generateId(String prefix, String suffix) Returns random ID with specified prefix and suffix.
static String	getSettingsKey(Object... settings) Returns settings combined into a single key.
static String	getSystemLineSeparator() Returns preferred system text lines separator.
static String	getWord(String text, int location) Returns a word from text at the specified location.
static int	getWordEnd(String text, int location) Returns a word end index at the specified location.
static int	getWordStart(String text, int location) Returns index of the first character in the word at the specified location.
static boolean	isBlank(String text) Returns whether or not specified text is null or empty excluding linebreaks and whitespaces.
static boolean	isEmpty(String text) Returns whether or not specified text is null or empty.
static int	length(String text) Returns specified text length.
static <T> String	listToString(List<T> list) Returns single text combined from list of elements using default separator.
static <T> String	listToString(List<T> list, String separator) Returns single text combined from list of elements using specified separator.
static <T> String	listToString(List<T> list, String separator, Function<T,String> textProvider) Returns single text combined from list of elements using specified separator.
static <T> String	listToString(List<T> list, String separator, Function<T,String> textProvider, Filter<T> filter) Returns single text combined from list of elements using specified separator.
static boolean	notBlank(String text) Returns whether or not specified text is null or empty excluding linebreaks and whitespaces.
static boolean	notEmpty(String text) Returns whether or not specified text is null or empty.
static List<String>	numbered(String pattern, int from, int to) Returns list of strings based on single pattern parsed using different number values in range.
static Point	parsePoint(String text) Returns point extracted from text.
static Point	parsePoint(String text, String separator) Returns point extracted from text.
static String	removeFirstLines(String text, int count) Returns text with first lines removed.
static String	removeLineBreaks(String text) Returns text with all line breaks removed.
static String	removeSpacings(String text) Returns text with all spacings removed.
static String	replace(String text, int index, char character) Returns text with replaced character at the specified index.
static String	replaceAll(String text, boolean ignoreCase, String str, Function<String,String> replacer) Replaces all occurrences of str found in the specified text with provided text.
static String	requireNonEmpty(String text) Checks that the specified text is not null or empty and throws a NullPointerException if it is.
static String	requireNonEmpty(String text, String message) Checks that the specified text is not null or empty and throws a NullPointerException if it is.
static String	requireNonEmpty(String text, Supplier<RuntimeException> exceptionSupplier) Checks that the specified text is not null or empty and throws a RuntimeException if it is.
static String	shortenText(String text, int maxLength, boolean addDots) Returns shortened text.
static String	shortenTextEnd(String text, int maxLength, boolean addDots) Returns shortened text.
static List<Float>	stringToFloatList(String string) Returns a list of float parts split using specified separator.
static List<Float>	stringToFloatList(String string, String separator) Returns a list of float parts split using specified separator.
static List<Integer>	stringToIntList(String string) Returns a list of integer parts split using specified separator.
static List<Integer>	stringToIntList(String string, String separator) Returns a list of integer parts split using specified separator.
static List<String>	stringToList(String string) Returns a list of text parts split using specified separator.
static List<String>	stringToList(String string, String separator) Returns a list of text parts split using specified separator.
static String	unite(String separator, String... parts) Converts and returns specified parts which are not null into single string.

Methods inherited from class java.lang.Object

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

Method Detail

getSystemLineSeparator

@NotNull
public static String getSystemLineSeparator()

Returns preferred system text lines separator.

Returns:

preferred system text lines separator

format

@NotNull
public static String format(@NotNull
                                     String text,
                                     @Nullable
                                     Object... objects)

Returns message formatted with common string representations of the provided objects.

Parameters:

text - message to format

objects - objects to use for message formatting

Returns:

message formatted with common string representations of the provided objects

replace

@NotNull
public static String replace(@NotNull
                                      String text,
                                      int index,
                                      char character)

Returns text with replaced character at the specified index.

Parameters:

text - text to replace character in

index - index of the character to replace

character - replacement character

Returns:

text with replaced character at the specified index

equals

public static boolean equals(@Nullable
                             String string,
                             @Nullable
                             String compareWith)

Returns whether the first String equals to second one. This method will compare String even if they are null without throwing any exceptions.

Parameters:

string - String to compare

compareWith - String to compare with

Returns:

true if the first String equals second one, false otherwise

equalsIgnoreCase

public static boolean equalsIgnoreCase(@Nullable
                                       String string,
                                       @Nullable
                                       String compareWith)

Returns whether the first String equals to second one ignoring case. This method will compare String even if they are null without throwing any exceptions.

Parameters:

string - String to compare

compareWith - String to compare with

Returns:

true if the first String equals second one ignoring case, false otherwise

numbered

@NotNull
public static List<String> numbered(@NotNull
                                             String pattern,
                                             int from,
                                             int to)

Returns list of strings based on single pattern parsed using different number values in range.

Parameters:

pattern - values pattern

from - range start

to - range end

Returns:

list of strings based on single pattern parsed using different number values in range

removeLineBreaks

@NotNull
public static String removeLineBreaks(@NotNull
                                               String text)

Returns text with all line breaks removed.

Parameters:

text - text to remove line breaks from

Returns:

text with all line breaks removed

removeSpacings

@NotNull
public static String removeSpacings(@NotNull
                                             String text)

Returns text with all spacings removed.

Parameters:

text - text to remove spacings from

Returns:

text with all spacings removed

findFirstNumber

@NotNull
public static Integer findFirstNumber(@NotNull
                                               String text)

Returns first number found in text.

Parameters:

text - text to search through

Returns:

first found number

getWord

@Nullable
public static String getWord(@NotNull
                                       String text,
                                       int location)

Returns a word from text at the specified location.

Parameters:

text - text to retrieve the word from

location - word location

Returns:

word

getWordStart

public static int getWordStart(@NotNull
                               String text,
                               int location)

Returns index of the first character in the word at the specified location.

Parameters:

text - text to retrieve the word start index from

location - word location

Returns:

index of the first character in the word at the specified location

getWordEnd

public static int getWordEnd(@NotNull
                             String text,
                             int location)

Returns a word end index at the specified location.

Parameters:

text - text to retrieve the word end index from

location - word location

Returns:

word end index

findLastRowWordStartIndex

public static int findLastRowWordStartIndex(@NotNull
                                            String string)

Returns begin index of last word in the specified text.

Parameters:

string - text to process

Returns:

begin index of last word in the specified text

findFirstWordFromIndex

public static int findFirstWordFromIndex(@NotNull
                                         String string,
                                         int from)

Returns begin index of first word after specified index.

Parameters:

string - text to process

from - index to start search from

Returns:

begin index of first word after specified index

findFirstRowWordEndIndex

public static int findFirstRowWordEndIndex(@NotNull
                                           String string)

Returns last index of the first word end.

Parameters:

string - text to process

Returns:

last index of the first word end

removeFirstLines

@NotNull
public static String removeFirstLines(@NotNull
                                               String text,
                                               int count)

Returns text with first lines removed.

Parameters:

text - text to crop

count - lines count to crop

Returns:

cropped text

parsePoint

@Nullable
public static Point parsePoint(@NotNull
                                         String text)

Returns point extracted from text.

Parameters:

text - text to extract point from

Returns:

extracted point

parsePoint

@Nullable
public static Point parsePoint(@NotNull
                                         String text,
                                         @NotNull
                                         String separator)

Returns point extracted from text.

Parameters:

text - text to extract point from

separator - point values separator

Returns:

extracted point

shortenText

@NotNull
public static String shortenText(@NotNull
                                          String text,
                                          int maxLength,
                                          boolean addDots)

Returns shortened text.

Parameters:

text - text to shorten

maxLength - maximum shortened text length

addDots - add dots at the end of the text when shortened

Returns:

shortened text

shortenTextEnd

@NotNull
public static String shortenTextEnd(@NotNull
                                             String text,
                                             int maxLength,
                                             boolean addDots)

Returns shortened text.

Parameters:

text - text to shorten

maxLength - maximum shortened text length

addDots - add dots at the end of the text when shortened

Returns:

shortened text

stringToList

@NotNull
public static List<String> stringToList(@Nullable
                                                 String string)

Returns a list of text parts split using specified separator.

Parameters:

string - text to split

Returns:

list of split parts

stringToList

@NotNull
public static List<String> stringToList(@Nullable
                                                 String string,
                                                 @NotNull
                                                 String separator)

Returns a list of text parts split using specified separator.

Parameters:

string - text to split

separator - text parts separator

Returns:

list of split parts

stringToIntList

@NotNull
public static List<Integer> stringToIntList(@Nullable
                                                     String string)

Returns a list of integer parts split using specified separator.

Parameters:

string - text to split

Returns:

list of split parts

stringToIntList

@NotNull
public static List<Integer> stringToIntList(@Nullable
                                                     String string,
                                                     @NotNull
                                                     String separator)

Returns a list of integer parts split using specified separator.

Parameters:

string - text to split

separator - text parts separator

Returns:

list of split parts

stringToFloatList

@NotNull
public static List<Float> stringToFloatList(@Nullable
                                                     String string)

Returns a list of float parts split using specified separator.

Parameters:

string - text to split

Returns:

list of split parts

stringToFloatList

@NotNull
public static List<Float> stringToFloatList(@Nullable
                                                     String string,
                                                     @NotNull
                                                     String separator)

Returns a list of float parts split using specified separator.

Parameters:

string - text to split

separator - text parts separator

Returns:

list of split parts

listToString

@Nullable
public static <T> String listToString(@Nullable
                                                List<T> list)

Returns single text combined from list of elements using default separator.

Type Parameters:

T - elements type

Parameters:

list - list to combine into single text

Returns:

single text combined from list of elements using default separator

listToString

@Nullable
public static <T> String listToString(@Nullable
                                                List<T> list,
                                                @NotNull
                                                String separator)

Returns single text combined from list of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

list - list to combine into single text

separator - elements separator

Returns:

single text combined from list of elements using specified separator

listToString

@Nullable
public static <T> String listToString(@Nullable
                                                List<T> list,
                                                @NotNull
                                                String separator,
                                                @NotNull
                                                Function<T,String> textProvider)

Returns single text combined from list of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

list - list to combine into single text

separator - elements separator

textProvider - Function providing text

Returns:

single text combined from list of elements using specified separator

listToString

@Nullable
public static <T> String listToString(@Nullable
                                                List<T> list,
                                                @NotNull
                                                String separator,
                                                @NotNull
                                                Function<T,String> textProvider,
                                                @Nullable
                                                Filter<T> filter)

Returns single text combined from list of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

list - list to combine into single text

separator - elements separator

textProvider - Function providing text

filter - Filter for elements

Returns:

single text combined from list of elements using specified separator

collectionToString

@Nullable
public static <T> String collectionToString(@Nullable
                                                      Collection<T> collection)

Returns single text combined from Collection of elements using default separator.

Type Parameters:

T - elements type

Parameters:

collection - Collection to combine into single text

Returns:

single text combined from Collection of elements using default separator

collectionToString

@Nullable
public static <T> String collectionToString(@Nullable
                                                      Collection<T> collection,
                                                      @NotNull
                                                      String separator)

Returns single text combined from Collection of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

collection - Collection to combine into single text

separator - elements separator

Returns:

single text combined from Collection of elements using specified separator

collectionToString

@Nullable
public static <T> String collectionToString(@Nullable
                                                      Collection<T> collection,
                                                      @NotNull
                                                      String separator,
                                                      @NotNull
                                                      Function<T,String> textProvider)

Returns single text combined from Collection of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

collection - Collection to combine into single text

separator - elements separator

textProvider - Function providing text

Returns:

single text combined from Collection of elements using specified separator

collectionToString

@Nullable
public static <T> String collectionToString(@Nullable
                                                      Collection<T> collection,
                                                      @NotNull
                                                      String separator,
                                                      @NotNull
                                                      Function<T,String> textProvider,
                                                      @Nullable
                                                      Filter<T> filter)

Returns single text combined from Collection of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

collection - Collection to combine into single text

separator - elements separator

textProvider - Function providing text

filter - Filter for elements

Returns:

single text combined from Collection of elements using specified separator

arrayToString

@Nullable
public static <T> String arrayToString(@Nullable
                                                 T... array)

Returns single text combined from array of elements using default separator.

Type Parameters:

T - elements type

Parameters:

array - array to combine into single text

Returns:

single text combined from array of elements using default separator

arrayToString

@Nullable
public static <T> String arrayToString(@NotNull
                                                 String separator,
                                                 @Nullable
                                                 T... array)

Returns single text combined from array of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

separator - elements separator

array - array to combine into single text

Returns:

single text combined from array of elements using specified separator

arrayToString

@Nullable
public static <T> String arrayToString(@NotNull
                                                 String separator,
                                                 @NotNull
                                                 Function<T,String> textProvider,
                                                 @Nullable
                                                 T... array)

Returns single text combined from array of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

separator - elements separator

textProvider - Function providing text

array - array to combine into single text

Returns:

single text combined from array of elements using specified separator

arrayToString

@Nullable
public static <T> String arrayToString(@NotNull
                                                 String separator,
                                                 @NotNull
                                                 Function<T,String> textProvider,
                                                 @Nullable
                                                 Filter<T> filter,
                                                 @Nullable
                                                 T... array)

Returns single text combined from array of elements using specified separator.

Type Parameters:

T - elements type

Parameters:

separator - elements separator

textProvider - Function providing text

filter - Filter for elements

array - array to combine into single text

Returns:

single text combined from array of elements using specified separator

enumArrayToString

@Nullable
public static <E extends Enum<E>> String enumArrayToString(@Nullable
                                                                     E... enumArray)

Converts array of enumeration constants into string with list of enumeration constants and returns it.

Type Parameters:

E - enumeration type

Parameters:

enumArray - enumeration constants array

Returns:

string with list of enumeration constants

enumArrayToString

@Nullable
public static <E extends Enum<E>> String enumArrayToString(@NotNull
                                                                     String separator,
                                                                     @Nullable
                                                                     E... enumArray)

Converts array of enumeration constants into string with list of enumeration constants and returns it.

Type Parameters:

E - enumeration type

Parameters:

separator - text parts separator

enumArray - enumeration constants array

Returns:

string with list of enumeration constants

enumListToString

@Nullable
public static <E extends Enum<E>> String enumListToString(@Nullable
                                                                    List<E> enumList)

Converts list of enumeration constants into string with list of enumeration constants and returns it.

Type Parameters:

E - enumeration type

Parameters:

enumList - enumeration constants list

Returns:

string with list of enumeration constants

enumListToString

@Nullable
public static <E extends Enum<E>> String enumListToString(@Nullable
                                                                    List<E> enumList,
                                                                    @NotNull
                                                                    String separator)

Converts list of enumeration constants into string with list of enumeration constants and returns it.

Type Parameters:

E - enumeration type

Parameters:

enumList - enumeration constants list

separator - text parts separator

Returns:

string with list of enumeration constants

enumStringToList

@NotNull
public static <E extends Enum<E>> List<E> enumStringToList(@Nullable
                                                                    String enumString,
                                                                    @NotNull
                                                                    Class<E> enumClass)

Converts string with list of enumeration constants into real list of enumeration constants and returns it.

Type Parameters:

E - enumeration type

Parameters:

enumString - enumeration constants string list

enumClass - enumeration class

Returns:

list of enumeration constants

enumStringToList

@NotNull
public static <E extends Enum<E>> List<E> enumStringToList(@Nullable
                                                                    String enumString,
                                                                    @NotNull
                                                                    Class<E> enumClass,
                                                                    @NotNull
                                                                    String separator)

Converts string with list of enumeration constants into real list of enumeration constants and returns it.

Type Parameters:

E - enumeration type

Parameters:

enumString - enumeration constants string list

enumClass - enumeration class

separator - text parts separator

Returns:

list of enumeration constants

unite

@NotNull
public static String unite(@NotNull
                                    String separator,
                                    @Nullable
                                    String... parts)

Converts and returns specified parts which are not null into single string.

Parameters:

separator - separator to place between parts

parts - parts to unite

Returns:

united non-null parts

length

public static int length(@Nullable
                         String text)

Returns specified text length.

Parameters:

text - text to check

Returns:

specified text length

isEmpty

public static boolean isEmpty(@Nullable
                              String text)

Returns whether or not specified text is null or empty.

Parameters:

text - text to check

Returns:

true if specified text is null or empty, false otherwise

notEmpty

public static boolean notEmpty(@Nullable
                               String text)

Returns whether or not specified text is null or empty.

Parameters:

text - text to check

Returns:

true if specified text is not null or empty, false otherwise

isBlank

public static boolean isBlank(@Nullable
                              String text)

Returns whether or not specified text is null or empty excluding linebreaks and whitespaces.

Parameters:

text - text to check

Returns:

true if specified text is null or empty excluding linebreaks and whitespaces, false otherwise

notBlank

public static boolean notBlank(@Nullable
                               String text)

Returns whether or not specified text is null or empty excluding linebreaks and whitespaces.

Parameters:

text - text to check

Returns:

true if specified text is not null or empty excluding linebreaks and whitespaces, false otherwise

requireNonEmpty

@NotNull
public static String requireNonEmpty(@Nullable
                                              String text)

Checks that the specified text is not null or empty and throws a NullPointerException if it is.

Parameters:

text - text to check for being null or empty

Returns:

text if not null or empty

Throws:

NullPointerException - if text is null or empty

requireNonEmpty

@NotNull
public static String requireNonEmpty(@Nullable
                                              String text,
                                              @NotNull
                                              String message)

Checks that the specified text is not null or empty and throws a NullPointerException if it is.

Parameters:

text - text to check for being null or empty

message - detailed message used in NullPointerException

Returns:

text if not null or empty

Throws:

NullPointerException - if text is null or empty

requireNonEmpty

@NotNull
public static String requireNonEmpty(@Nullable
                                              String text,
                                              @NotNull
                                              Supplier<RuntimeException> exceptionSupplier)

Checks that the specified text is not null or empty and throws a RuntimeException if it is.

Parameters:

text - text to check for being null or empty

exceptionSupplier - Supplier for a customized RuntimeException

Returns:

text if not null or empty

Throws:

RuntimeException - if text is null or empty

createString

@NotNull
public static String createString(@NotNull
                                           String character,
                                           int length)

Creates new string filled with specified amount of same characters.

Parameters:

character - character to fill string with

length - string length

Returns:

new string filled with specified amount of same characters

createString

@NotNull
public static String createString(char character,
                                           int length)

Creates new string filled with specified amount of same characters.

Parameters:

character - character to fill string with

length - string length

Returns:

new string filled with specified amount of same characters

replaceAll

@NotNull
public static String replaceAll(@NotNull
                                         String text,
                                         boolean ignoreCase,
                                         @NotNull
                                         String str,
                                         @NotNull
                                         Function<String,String> replacer)

Replaces all occurrences of str found in the specified text with provided text.

Parameters:

text - text to replace string occurrences in

ignoreCase - whether should ignore case while searching for occurrences or not

str - text to replace

replacer - text replacement Function

Returns:

text with replaced occurrences of the specified str

generateId

@NotNull
public static String generateId()

Returns random ID with default prefix and suffix.

Returns:

ID

generateId

@NotNull
public static String generateId(@Nullable
                                         String prefix)

Returns random ID with specified prefix and default suffix.

Parameters:

prefix - id prefix

Returns:

ID

generateId

@NotNull
public static String generateId(@Nullable
                                         String prefix,
                                         @Nullable
                                         String suffix)

Returns random ID with specified prefix and suffix.

Parameters:

prefix - id prefix

suffix - id suffix

Returns:

ID

generateId

@NotNull
public static String generateId(int length)

Returns randomly generated ID part with specified length.

Parameters:

length - part length in symbols

Returns:

ID part

getSettingsKey

@NotNull
public static String getSettingsKey(@NotNull
                                             Object... settings)

Returns settings combined into a single key. This method might be useful for generating complex cache keys.

Parameters:

settings - settings to combine

Returns:

key for the specified shape settings