Modifier and Type	Class and Description
private static record	StringUtils.OnePart
private static record	StringUtils.TwoParts
public static interface	StringUtils.TwoPartSplitResult The result of splitting a string into up to two parts.

Modifier and Type	Field and Description
private static final Pattern	ISO_CONTROL_PATTERN
private static final Pattern	WHITESPACE_PATTERN

Access	Constructor and Description
private	StringUtils()

Method Summary

Modifier and Type	Method and Description
pack-priv static Pattern	compileIsoControlPattern() Guard against "IllegalArgumentException: Unsupported flags: 256" errors.
public static boolean	Returns: `true` if the string contains an ISO control character containsIsoControlCharacter(@Nullable String the string to check; may be `null` str) Determine if the supplied `String` contains any ISO control characters.
public static boolean	Returns: `true` if the string contains whitespace containsWhitespace(@Nullable String the string to check; may be `null` str) Determine if the supplied `String` contains any whitespace characters.
public static String	Returns: the default String representation of the supplied object; never `null` defaultToString(@Nullable Object the object to convert to a String; may be `null` obj) Convert the supplied `Object` to a default `String` representation using the following algorithm.
public static boolean	Returns: `true` if the string does not contain an ISO control character doesNotContainIsoControlCharacter(@Nullable String the string to check; may be `null` str) Determine if the supplied `String` does not contain any ISO control characters.
public static boolean	Returns: `true` if the string does not contain whitespace doesNotContainWhitespace(@Nullable String the string to check; may be `null` str) Determine if the supplied `String` does not contain any whitespace characters.
public static boolean	Returns: `true` if the string is blank isBlank(@Nullable String the string to check; may be `null` str) Determine if the supplied `String` is blank (i.e., `null` or consisting only of whitespace characters).
public static boolean	Returns: `true` if the string is not blank isNotBlank(@Nullable String the string to check; may be `null` str) Determine if the supplied `String` is not blank.
public static String	Returns: a String representation of the supplied object; never `null` nullSafeToString(@Nullable Object the object to convert to a String; may be `null` obj) Convert the supplied `Object` to a `String` using the following algorithm.
public static @Nullable String	Returns: the supplied string with all control characters replaced, or `null` if the supplied string was `null` replaceIsoControlCharacters(@Nullable String the string in which to perform the replacement; may be `null` str, String the replacement string; never `null` replacement) Replace all ISO control characters in the supplied `String`.
public static @Nullable String	Returns: the supplied string with all whitespace characters replaced, or `null` if the supplied string was `null` replaceWhitespaceCharacters(@Nullable String the string in which to perform the replacement; may be `null` str, String the replacement string; never `null` replacement) Replace all whitespace characters in the supplied `String`.
public static StringUtils.TwoPartSplitResult	splitIntoTwo(char the separator character separator, String the value to split; never `null` value) Split the supplied `String` into up to two parts using the supplied separator character.
public static StringUtils.TwoPartSplitResult	splitIntoTwo(String the separator string; never `null` separator, String the value to split; never `null` value) Split the supplied `String` into up to two parts using the supplied separator string.
private static StringUtils.TwoPartSplitResult	splitIntoTwo(String value, int index, int length)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ISO_CONTROL_PATTERN	back to summary
private static final Pattern ISO_CONTROL_PATTERN

WHITESPACE_PATTERN	back to summary
private static final Pattern WHITESPACE_PATTERN

Constructor Detail

StringUtils	back to summary
private StringUtils()

Method Detail

compileIsoControlPattern	back to summary
pack-priv static Pattern compileIsoControlPattern() Guard against "IllegalArgumentException: Unsupported flags: 256" errors. See Also #1800

compileIsoControlPattern

back to summary

pack-priv static Pattern compileIsoControlPattern()

Guard against "IllegalArgumentException: Unsupported flags: 256" errors.

See Also: #1800

containsIsoControlCharacter back to summary

containsIsoControlCharacter	back to summary
public static boolean containsIsoControlCharacter(@Nullable String str) Determine if the supplied `String` contains any ISO control characters. Parameters str:@Nullable String the string to check; may be `null` Returns:boolean `true` if the string contains an ISO control character Annotations @Contract:null -> false See Also `containsWhitespace(String)`, `Character#isISOControl(int)`

public static boolean containsIsoControlCharacter(@Nullable String str)

Determine if the supplied String contains any ISO control characters.

Parameters

str:@Nullable String: the string to check; may be null

Returns:boolean

true if the string contains an ISO control character

Annotations

@Contract:null -> false

containsWhitespace back to summary

containsWhitespace	back to summary
public static boolean containsWhitespace(@Nullable String str) Determine if the supplied `String` contains any whitespace characters. Parameters str:@Nullable String the string to check; may be `null` Returns:boolean `true` if the string contains whitespace Annotations @Contract:null -> false See Also `containsIsoControlCharacter(String)`, `Character#isWhitespace(int)`

public static boolean containsWhitespace(@Nullable String str)

Determine if the supplied String contains any whitespace characters.

Parameters

str:@Nullable String: the string to check; may be null

Returns:boolean

true if the string contains whitespace

Annotations

@Contract:null -> false

defaultToString back to summary

defaultToString	back to summary
public static String defaultToString(@Nullable Object obj) Convert the supplied `Object` to a default `String` representation using the following algorithm. If the supplied object is `null`, this method returns `"null"`. Otherwise, the String returned by this method will be generated analogous to the default implementation of `Object#toString()` by using the supplied object's class name and hash code as follows: `obj.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(obj))` Parameters obj:@Nullable Object the object to convert to a String; may be `null` Returns:String the default String representation of the supplied object; never `null` See Also `nullSafeToString(Object)`, `ClassUtils#nullSafeToString(Class...)`

public static String defaultToString(@Nullable Object obj)

Convert the supplied Object to a default String representation using the following algorithm.

If the supplied object is null, this method returns "null".
Otherwise, the String returned by this method will be generated analogous to the default implementation of Object#toString() by using the supplied object's class name and hash code as follows: obj.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(obj))

Parameters

obj:@Nullable Object: the object to convert to a String; may be null

Returns:String

the default String representation of the supplied object; never null

doesNotContainIsoControlCharacter back to summary

doesNotContainIsoControlCharacter	back to summary
public static boolean doesNotContainIsoControlCharacter(@Nullable String str) Determine if the supplied `String` does not contain any ISO control characters. Parameters str:@Nullable String the string to check; may be `null` Returns:boolean `true` if the string does not contain an ISO control character Annotations @Contract:null -> true See Also `containsIsoControlCharacter(String)`, `containsWhitespace(String)`, `Character#isISOControl(int)`

public static boolean doesNotContainIsoControlCharacter(@Nullable String str)

Determine if the supplied String does not contain any ISO control characters.

Parameters

str:@Nullable String: the string to check; may be null

Returns:boolean

true if the string does not contain an ISO control character

Annotations

@Contract:null -> true

doesNotContainWhitespace back to summary

doesNotContainWhitespace	back to summary
public static boolean doesNotContainWhitespace(@Nullable String str) Determine if the supplied `String` does not contain any whitespace characters. Parameters str:@Nullable String the string to check; may be `null` Returns:boolean `true` if the string does not contain whitespace Annotations @Contract:null -> true See Also `containsWhitespace(String)`, `containsIsoControlCharacter(String)`, `Character#isWhitespace(int)`

public static boolean doesNotContainWhitespace(@Nullable String str)

Determine if the supplied String does not contain any whitespace characters.

Parameters

str:@Nullable String: the string to check; may be null

Returns:boolean

true if the string does not contain whitespace

Annotations

@Contract:null -> true

isBlank back to summary

isBlank	back to summary
public static boolean isBlank(@Nullable String str) Determine if the supplied `String` is blank (i.e., `null` or consisting only of whitespace characters). Parameters str:@Nullable String the string to check; may be `null` Returns:boolean `true` if the string is blank Annotations @Contract:null -> true See Also `String#isBlank()`, `isNotBlank(String)`

public static boolean isBlank(@Nullable String str)

Determine if the supplied String is blank (i.e., null or consisting only of whitespace characters).

Parameters

str:@Nullable String: the string to check; may be null

Returns:boolean

true if the string is blank

Annotations

@Contract:null -> true

isNotBlank back to summary

isNotBlank	back to summary
public static boolean isNotBlank(@Nullable String str) Determine if the supplied `String` is not blank. Parameters str:@Nullable String the string to check; may be `null` Returns:boolean `true` if the string is not blank Annotations @Contract:null -> false See Also `isBlank(String)`

public static boolean isNotBlank(@Nullable String str)

Determine if the supplied String is not blank.

Parameters

str:@Nullable String: the string to check; may be null

Returns:boolean

true if the string is not blank

Annotations

@Contract:null -> false

See Also

isBlank(String)

nullSafeToString back to summary

nullSafeToString	back to summary
public static String nullSafeToString(@Nullable Object obj) Convert the supplied `Object` to a `String` using the following algorithm. If the supplied object is `null`, this method returns `"null"`. If the supplied object is a primitive array, the appropriate `Arrays#toString(...)` variant will be used to convert it to a String. If the supplied object is an object array, `Arrays#deepToString(Object[])` will be used to convert it to a String. Otherwise, `toString()` will be invoked on the object. If the result is non-null, that result will be returned. If the result is `null`, `"null"` will be returned. If any of the above results in an exception, this method delegates to `defaultToString(Object)` Parameters obj:@Nullable Object the object to convert to a String; may be `null` Returns:String a String representation of the supplied object; never `null` See Also `Arrays#deepToString(Object[])`, `ClassUtils#nullSafeToString(Class...)`

public static String nullSafeToString(@Nullable Object obj)

Convert the supplied Object to a String using the following algorithm.

If the supplied object is null, this method returns "null".
If the supplied object is a primitive array, the appropriate Arrays#toString(...) variant will be used to convert it to a String.
If the supplied object is an object array, Arrays#deepToString(Object[]) will be used to convert it to a String.
Otherwise, toString() will be invoked on the object. If the result is non-null, that result will be returned. If the result is null, "null" will be returned.
If any of the above results in an exception, this method delegates to defaultToString(Object)

Parameters

obj:@Nullable Object: the object to convert to a String; may be null

Returns:String

a String representation of the supplied object; never null

replaceIsoControlCharacters back to summary

replaceIsoControlCharacters	back to summary
public static @Nullable String replaceIsoControlCharacters(@Nullable String str, String replacement) Replace all ISO control characters in the supplied `String`. Parameters str:@Nullable String the string in which to perform the replacement; may be `null` replacement:String the replacement string; never `null` Returns:@Nullable String the supplied string with all control characters replaced, or `null` if the supplied string was `null` Annotations @API status:INTERNAL since:1.4 @Contract:null, _ -> null; !null, _ -> !null Since 1.4

public static @Nullable String replaceIsoControlCharacters(@Nullable String str, String replacement)

Replace all ISO control characters in the supplied String.

Parameters

str:@Nullable String: the string in which to perform the replacement; may be null
replacement:String: the replacement string; never null

Returns:@Nullable String

the supplied string with all control characters replaced, or null if the supplied string was null

Annotations

@API
status:INTERNAL
since:1.4
@Contract:null, _ -> null; !null, _ -> !null

Since

1.4

replaceWhitespaceCharacters back to summary

replaceWhitespaceCharacters	back to summary
public static @Nullable String replaceWhitespaceCharacters(@Nullable String str, String replacement) Replace all whitespace characters in the supplied `String`. Parameters str:@Nullable String the string in which to perform the replacement; may be `null` replacement:String the replacement string; never `null` Returns:@Nullable String the supplied string with all whitespace characters replaced, or `null` if the supplied string was `null` Annotations @API status:INTERNAL since:1.4 @Contract:null, _ -> null; !null, _ -> !null Since 1.4

public static @Nullable String replaceWhitespaceCharacters(@Nullable String str, String replacement)

Replace all whitespace characters in the supplied String.

Parameters

str:@Nullable String: the string in which to perform the replacement; may be null
replacement:String: the replacement string; never null

Returns:@Nullable String

the supplied string with all whitespace characters replaced, or null if the supplied string was null

Annotations

@API
status:INTERNAL
since:1.4
@Contract:null, _ -> null; !null, _ -> !null

Since

1.4

splitIntoTwo back to summary

splitIntoTwo	back to summary
public static StringUtils.TwoPartSplitResult splitIntoTwo(char separator, String value) Split the supplied `String` into up to two parts using the supplied separator character. Parameters separator:char the separator character value:String the value to split; never `null` Annotations @API status:INTERNAL since:1.11 Since 1.11

public static StringUtils.TwoPartSplitResult splitIntoTwo(char separator, String value)

Split the supplied String into up to two parts using the supplied separator character.

Parameters

separator:char: the separator character
value:String: the value to split; never null

Annotations

@API
status:INTERNAL
since:1.11

Since

1.11

splitIntoTwo back to summary

splitIntoTwo	back to summary
public static StringUtils.TwoPartSplitResult splitIntoTwo(String separator, String value) Split the supplied `String` into up to two parts using the supplied separator string. Parameters separator:String the separator string; never `null` value:String the value to split; never `null` Annotations @API status:INTERNAL since:1.11 Since 1.11

public static StringUtils.TwoPartSplitResult splitIntoTwo(String separator, String value)

Split the supplied String into up to two parts using the supplied separator string.

Parameters

separator:String: the separator string; never null
value:String: the value to split; never null

Annotations

@API
status:INTERNAL
since:1.11

Since

1.11

splitIntoTwo	back to summary
private static StringUtils.TwoPartSplitResult splitIntoTwo(String value, int index, int length)

org.junit.platform.commons.util back to summary

private final Record StringUtils.OnePart

Class Inheritance

extends Record
implements TwoPartSplitResult

java.lang.Object
java.lang.Record
org.junit.platform.commons.util.StringUtils.OnePart

All Implemented Interfaces

org.junit.platform.commons.util.StringUtils.TwoPartSplitResult

Record Components

value:String

Field Summary

Modifier and Type	Field and Description
private final String	value Record Component accessed by value().

Constructor Summary

Access	Constructor and Description
private	OnePart(String value)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public <T> T	map(Function<String, ? extends T> onePartMapper, BiFunction<String, String, ? extends T> twoPartsMapper) Implements org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map. Map the result of splitting a string into up to two parts.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public String	value() Record Component getter of value.

Field Detail

value	back to summary
private final String value Record Component accessed by value().

Constructor Detail

OnePart	back to summary
private OnePart(String value)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

map	back to summary
public <T> T map(Function<String, ? extends T> onePartMapper, BiFunction<String, String, ? extends T> twoPartsMapper) Implements org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map. Doc from org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map. Map the result of splitting a string into up to two parts. Annotations @Override

map

back to summary

public <T> T map(Function<String, ? extends T> onePartMapper, BiFunction<String, String, ? extends T> twoPartsMapper)

Implements org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map.

Doc from org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map.

Map the result of splitting a string into up to two parts.

Annotations

@Override

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

value	back to summary
public String value() Record Component getter of value.

org.junit.platform.commons.util back to summary

private final Record StringUtils.TwoParts

Class Inheritance

extends Record
implements TwoPartSplitResult

java.lang.Object
java.lang.Record
org.junit.platform.commons.util.StringUtils.TwoParts

All Implemented Interfaces

org.junit.platform.commons.util.StringUtils.TwoPartSplitResult

Record Components

first:String
second:String

Field Summary

Modifier and Type	Field and Description
private final String	first Record Component accessed by first().
private final String	second Record Component accessed by second().

Constructor Summary

Access	Constructor and Description
private	TwoParts(String first, String second)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public String	first() Record Component getter of first.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public <T> T	map(Function<String, ? extends T> onePartMapper, BiFunction<String, String, ? extends T> twoPartsMapper) Implements org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map. Map the result of splitting a string into up to two parts.
public String	second() Record Component getter of second.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

first	back to summary
private final String first Record Component accessed by first().

second	back to summary
private final String second Record Component accessed by second().

Constructor Detail

TwoParts	back to summary
private TwoParts(String first, String second)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

first	back to summary
public String first() Record Component getter of first.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

map	back to summary
public <T> T map(Function<String, ? extends T> onePartMapper, BiFunction<String, String, ? extends T> twoPartsMapper) Implements org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map. Doc from org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map. Map the result of splitting a string into up to two parts. Annotations @Override

map

back to summary

public <T> T map(Function<String, ? extends T> onePartMapper, BiFunction<String, String, ? extends T> twoPartsMapper)

Implements org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map.

Doc from org.junit.platform.commons.util.StringUtils.TwoPartSplitResult.map.

Map the result of splitting a string into up to two parts.

Annotations

@Override

second	back to summary
public String second() Record Component getter of second.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

public final Class StringUtils

DISCLAIMER

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record StringUtils.OnePart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record StringUtils.TwoParts

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Interface StringUtils.TwoPartSplitResult

Method Summary

Method Detail

Modifier and Type	Method and Description
public <T> T	map(Function<String, ? extends T> the mapper to use if the string was split into a single part onePartMapper, BiFunction<String, String, ? extends T> the mapper to use if the string was split into two parts twoPartsMapper) Map the result of splitting a string into up to two parts.
public default <T> T	mapTwo(Supplier<? extends RuntimeException> the exception creator to use if the string was split into a single part onePartExceptionCreator, BiFunction<String, String, ? extends T> the mapper to use if the string was split into two parts twoPartsMapper) Map the result of splitting a string into two parts or throw an exception.