dev.jeka.core.api.utils

Class JkUtilsString

java.lang.Object

dev.jeka.core.api.utils.JkUtilsString

public final class JkUtilsString
extends java.lang.Object

Utility class for dealing with strings.

Constructor Summary

Constructors

Constructor and Description
JkUtilsString()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	blankToNull(java.lang.String in) Converts a blank string to null.
static java.lang.String	capitalize(java.lang.String string) Returns the specified string but upper-casing its first character.
static boolean	containsAny(java.lang.String stringToMatch, java.lang.String... candidates) Checks if the given string contains any of the specified candidate substrings.
static int	countOccurrence(java.lang.String matchedString, char occurrence) Returns occurrence count of the specified character into the specified string.
static java.lang.String	ellipse(java.lang.String string, int max) Returns the specified string truncated and ending with ... if the specified string is longer than the specified max length.
static java.lang.String	emptyToNull(java.lang.String in) Converts an empty or blank string to null.
static boolean	endsWithAny(java.lang.String stringToMatch, java.lang.String... candidates) Returns true if the specified string ends with any of the candidates.
static java.util.List<java.lang.String>	extractVariableToken(java.lang.String string) Extracts variable tokens enclosed in `${}` from the provided string.
static java.lang.String	firstMatching(java.lang.String stringToMatch, java.lang.String... candidates) Returns the first string out of the specified candidates matching the specified string.
static java.lang.String	formatOptions(java.util.List<java.lang.String> options) Converts a list of options into a formatted string representation.
static java.lang.String	interpolate(java.lang.String string, java.util.function.Function<java.lang.String,java.lang.String> replacer) Replaces variable tokens in the given string with the corresponding values provided by the replacer function.
static boolean	isBlank(java.lang.String string) Checks if a String is whitespace, empty ("") or null.
static boolean	isDigits(java.lang.String string) Checks if the provided string consists only of digits.
static java.lang.String	nullToEmpty(java.lang.String in) Converts a null string to an empty string.
static java.lang.String	padEnd(java.lang.String string, int minLength, char padChar) Pads the given string with the specified pad character to ensure it reaches the minimum length.
static java.lang.String	padStart(java.lang.String string, int minLength, char padChar) Pads the given string with the specified pad character to ensure it reaches the minimum length.
static java.lang.String[]	parseCommandline(java.lang.String commandline) Parses a command line string and splits it into an array of individual command line arguments.
static java.util.List<java.lang.String>	parseCommandlineAsList(java.lang.String commandline)
static java.lang.String	pluralize(int count, java.lang.String singular) Returns a string containing the quantity and noun.
static java.lang.String	pluralize(int count, java.lang.String singular, java.lang.String plural) Returns a string containing the quantity and noun.
static java.lang.String	readableCommandAgs(java.lang.String margin, java.util.List<java.lang.String> options) Returns a readable representation of command line arguments.
static java.lang.String	removePackagePrefix(java.lang.String fullName) Removes the package prefix from a fully qualified name, leaving only the last class name and the subsequent part (e.g., method name or variable).
static java.lang.String	repeat(java.lang.String pattern, int count) Returns a string made of the specified pattern repeat the specified count.
static java.lang.String	shortenPackageName(java.lang.String fullName) Shortens a fully qualified package name by abbreviating all segments except the last class name and appends the remaining part after the class, preserving the structure.
static java.util.List<java.lang.String>	splitWhiteSpaces(java.lang.String string) Splits the provided string into a list of substrings based on whitespace.
static boolean	startsWithAny(java.lang.String stringToMatch, java.lang.String... stringToCheckEquals) Returns true if the specified string starts with any of the candidates.
static boolean	startsWithUpperCase(java.lang.String str) Checks if the given string starts with an uppercase letter.
static java.lang.String	substringAfterFirst(java.lang.String string, java.lang.String delimiter) Returns the substring after the first delimiter of the specified occurrence.
static java.lang.String	substringAfterLast(java.lang.String string, java.lang.String delimiter) Returns the substring after the last delimiter of the specified occurrence.
static java.lang.String	substringBeforeFirst(java.lang.String string, java.lang.String delimiter) Returns the substring before the first delimiter of the specified occurrence.
static java.lang.String	substringBeforeLast(java.lang.String string, java.lang.String delimiter) Returns the substring before the last delimiter of the specified occurrence.
static java.lang.String	toHexString(byte[] raw) Returns the hexadecimal for of the given array of bytes.
static java.lang.String	uncapitalize(java.lang.String string) Returns the specified string but lower-casing its first character.
static java.lang.String	withLeftMargin(java.lang.String paragraph, java.lang.String margin) Returns a string with a left margin added to each line.
static java.lang.String	wrapStringCharacterWise(java.lang.String input, int maxLineLength) Wraps the given string character-wise to fit within the specified width.

Methods inherited from class java.lang.Object

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

Constructor Detail

JkUtilsString

public JkUtilsString()

Method Detail

capitalize

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

Returns the specified string but upper-casing its first character.

uncapitalize

public static java.lang.String uncapitalize(java.lang.String string)

Returns the specified string but lower-casing its first character.

firstMatching

public static java.lang.String firstMatching(java.lang.String stringToMatch,
                                             java.lang.String... candidates)

Returns the first string out of the specified candidates matching the specified string.

countOccurrence

public static int countOccurrence(java.lang.String matchedString,
                                  char occurrence)

Returns occurrence count of the specified character into the specified string.

substringAfterLast

public static java.lang.String substringAfterLast(java.lang.String string,
                                                  java.lang.String delimiter)

Returns the substring after the last delimiter of the specified occurrence. The delimiter is not part of the result.

substringBeforeFirst

public static java.lang.String substringBeforeFirst(java.lang.String string,
                                                    java.lang.String delimiter)

Returns the substring before the first delimiter of the specified occurrence. The delimiter is not part of the result.

substringAfterFirst

public static java.lang.String substringAfterFirst(java.lang.String string,
                                                   java.lang.String delimiter)

Returns the substring after the first delimiter of the specified occurrence. The delimiter is not part of the result.

substringBeforeLast

public static java.lang.String substringBeforeLast(java.lang.String string,
                                                   java.lang.String delimiter)

Returns the substring before the last delimiter of the specified occurrence. The delimiter is not part of the result. Returns empty string if not found.

repeat

public static java.lang.String repeat(java.lang.String pattern,
                                      int count)

Returns a string made of the specified pattern repeat the specified count. So, for example, repeat("##", 3) will return ######

pluralize

public static java.lang.String pluralize(int count,
                                         java.lang.String singular,
                                         java.lang.String plural)

Returns a string containing the quantity and noun. The noun is the plural form if quantity > 1.

pluralize

public static java.lang.String pluralize(int count,
                                         java.lang.String singular)

Returns a string containing the quantity and noun. The noun is the plural form if quantity greater than 1. The plural form is singular form + 's';

toHexString

public static java.lang.String toHexString(byte[] raw)
                                    throws java.lang.IllegalArgumentException

Returns the hexadecimal for of the given array of bytes.

Throws:

java.lang.IllegalArgumentException

endsWithAny

public static boolean endsWithAny(java.lang.String stringToMatch,
                                  java.lang.String... candidates)

Returns true if the specified string ends with any of the candidates.

containsAny

public static boolean containsAny(java.lang.String stringToMatch,
                                  java.lang.String... candidates)

Checks if the given string contains any of the specified candidate substrings.

startsWithAny

public static boolean startsWithAny(java.lang.String stringToMatch,
                                    java.lang.String... stringToCheckEquals)

Returns true if the specified string starts with any of the candidates.

startsWithUpperCase

public static boolean startsWithUpperCase(java.lang.String str)

Checks if the given string starts with an uppercase letter.

Parameters:

str - the string to check; may be null or empty

Returns:

true if the string starts with an uppercase letter, false otherwise

isBlank

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

Checks if a String is whitespace, empty ("") or null.

isDigits

public static boolean isDigits(java.lang.String string)

Checks if the provided string consists only of digits.

extractVariableToken

public static java.util.List<java.lang.String> extractVariableToken(java.lang.String string)

Extracts variable tokens enclosed in `${}` from the provided string. A variable token is a string contained between `${` and `}`.

Parameters:

string - the input string from which to extract variable tokens

Returns:

a list of variable tokens without the enclosing `${}`; returns an empty list if no variable tokens are present

interpolate

public static java.lang.String interpolate(java.lang.String string,
                                           java.util.function.Function<java.lang.String,java.lang.String> replacer)

Replaces variable tokens in the given string with the corresponding values provided by the replacer function. Variable tokens are enclosed in `${}`.

Parameters:

string - the input string containing variable tokens to be replaced

replacer - a function that takes a variable token (without `${}`) and returns the replacement value for the token

Returns:

the resulting string after variable replacement

Throws:

java.lang.IllegalArgumentException - if no replacement is defined for a token

ellipse

public static java.lang.String ellipse(java.lang.String string,
                                       int max)

Returns the specified string truncated and ending with ... if the specified string is longer than the specified max length. Otherwise, the specified string is returned as is.

parseCommandline

public static java.lang.String[] parseCommandline(java.lang.String commandline)

Parses a command line string and splits it into an array of individual command line arguments.

Borrowed from ANT.

Parameters:

commandline - the command line string to parse

Returns:

an array of individual command line arguments

Throws:

java.lang.IllegalArgumentException - if there are unbalanced quotes in the command line string

parseCommandlineAsList

public static java.util.List<java.lang.String> parseCommandlineAsList(java.lang.String commandline)

See Also:

parseCommandline(String)

padEnd

public static java.lang.String padEnd(java.lang.String string,
                                      int minLength,
                                      char padChar)

Pads the given string with the specified pad character to ensure it reaches the minimum length.

Parameters:

string - The string to pad.

minLength - The minimum length the resulting string should have.

padChar - The character to use for padding.

Returns:

The padded string.

padStart

public static java.lang.String padStart(java.lang.String string,
                                        int minLength,
                                        char padChar)

Pads the given string with the specified pad character to ensure it reaches the minimum length.

Parameters:

string - The string to pad.

minLength - The minimum length the resulting string should have.

padChar - The character to use for padding.

Returns:

The padded string.

blankToNull

public static java.lang.String blankToNull(java.lang.String in)

Converts a blank string to null. If the input string is null, empty, or consists only of whitespaces, this method returns null. Otherwise, it returns the input string.

Parameters:

in - the input string

nullToEmpty

public static java.lang.String nullToEmpty(java.lang.String in)

Converts a null string to an empty string. If the input string is null, it returns an empty string. If the input string is not null, it returns the input string as is.

Parameters:

in - the input string

emptyToNull

public static java.lang.String emptyToNull(java.lang.String in)

Converts an empty or blank string to null. If the input string is non-empty and non-blank, it is returned unchanged.

wrapStringCharacterWise

public static java.lang.String wrapStringCharacterWise(java.lang.String input,
                                                       int maxLineLength)

Wraps the given string character-wise to fit within the specified width.

withLeftMargin

public static java.lang.String withLeftMargin(java.lang.String paragraph,
                                              java.lang.String margin)

Returns a string with a left margin added to each line. Each line in the provided paragraph will be prepended with the specified margin.

readableCommandAgs

public static java.lang.String readableCommandAgs(java.lang.String margin,
                                                  java.util.List<java.lang.String> options)

Returns a readable representation of command line arguments. Each option in the provided list is split by the platform's file separator and concatenated with a new line character (\n).

shortenPackageName

public static java.lang.String shortenPackageName(java.lang.String fullName)

Shortens a fully qualified package name by abbreviating all segments except the last class name and appends the remaining part after the class, preserving the structure. For instance, it replaces "com.example.package.ClassName.method" with "c.e.package.ClassName.method".

Parameters:

fullName - The fully qualified package name including the class and optionally the method. If null or if the input does not contain any dot, it is returned as-is.

Returns:

A shortened version of the given package name with abbreviated segments, or the original input for invalid cases.

removePackagePrefix

public static java.lang.String removePackagePrefix(java.lang.String fullName)

Removes the package prefix from a fully qualified name, leaving only the last class name and the subsequent part (e.g., method name or variable). This method shortens the package part by retaining only the class name preceding the final segment if it exists.

Parameters:

fullName - The fully qualified name from which the package prefix should be removed. If the input is null or does not contain a dot, it is returned as-is.

Returns:

The modified string with the package prefix removed, or the original string if no prefix exists or the input is invalid.

splitWhiteSpaces

public static java.util.List<java.lang.String> splitWhiteSpaces(java.lang.String string)

Splits the provided string into a list of substrings based on whitespace. Consecutive whitespaces are treated as a single delimiter. Each resulting substring is trimmed. If the input string is null, it is treated as an empty string.

Null or empty sting result in an empty list.

formatOptions

public static java.lang.String formatOptions(java.util.List<java.lang.String> options)

Converts a list of options into a formatted string representation. The formatting depends on the content of the options, where long options containing path separators are split into separate lines, options starting with a dash are formatted with additional indentation, and others are appended as is.

Parameters:

options - the list of options to be formatted as a string

Returns:

a string representation of the options with appropriate formatting