TextJoiner (MyTISM API Documentation)

java.lang.Object
- de.ipcon.tools.TextJoiner

```
public final class TextJoiner
extends java.lang.Object
```
Fluent builder for joining strings, collections, and object arrays with configurable delimiters, filtering, deduplication, escaping, and wrapping.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_SEPARATOR
The default separator for String joining and splitting: ", "

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_SEPARATOR` The default separator for String joining and splitting: ", "

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendTo(java.lang.StringBuilder sb, java.util.Collection<?> collection)`
`static TextJoiner`	`create()` Creates a new fluent `TextJoiner` instance with default settings.
`static TextJoiner`	`defaultingTo(java.lang.String defaultString)` Creates a builder preconfigured with a fallback string returned when the input collection or array is null or empty.
`TextJoiner`	`escape(boolean escape)` Configures whether escaping is enabled (default is `true`).
`static java.lang.String`	`escape(java.lang.String str, java.lang.String charsToEscape)` Escapes backslashes and any character present in `charsToEscape` by prefixing them with a single backslash ('\').
`static TextJoiner`	`escaping(boolean escape)` Creates a builder with escaping explicitly enabled or disabled.
`static TextJoiner`	`escapingWith(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> escaper)` Creates a builder preconfigured with a custom escaping function.
`java.lang.String`	`join(java.util.Collection<?> col)`
`java.lang.String`	`join(java.lang.Object[] array)`
`java.lang.String`	`join(java.lang.String[] array)`
`static java.lang.String`	`joinAll(java.util.Collection<?> col)` Joins collection elements using default delimiter (", ").
`static java.lang.String`	`joinAll(java.lang.Object[] array)` Joins array elements using default delimiter (", ").
`static java.lang.String`	`joinAll(java.lang.String[] array)` Joins array elements using default delimiter (", ").
`static java.lang.String`	`joinLastDifferent(java.lang.String[] strs, java.lang.String lastSep, java.lang.String sep)` Joins elements for natural language output where the final separator differs.
`java.lang.String`	`joinTwo(java.lang.String s1, java.lang.String s2)` Specialized joiner for 2 strings adhering to the contract: returns `null` if both inputs are null.
`static TextJoiner`	`on(char separator)` Convenience alias for single-character delimiters.
`static TextJoiner`	`on(java.lang.String separator)` Convenience alias for `separatedBy(String)`.
`static TextJoiner`	`prefixedWith(java.lang.String prefix)` Creates a builder preconfigured to prepend this string once at the beginning of the rendered output.
`TextJoiner`	`removeDuplicates(boolean removeDuplicates)` Deduplicates elements while preserving insertion order (first-seen wins).
`TextJoiner`	`removeEmptyStrings(boolean removeEmptyStrings)` Drops empty, whitespace-only, and null strings during iteration (equivalent to `StringUtils.isBlank`).
`TextJoiner`	`removeNulls(boolean removeNulls)` Drops literal `null` values during iteration.
`static TextJoiner`	`removingDuplicates(boolean removeDuplicates)` Creates a builder with deduplication explicitly configured.
`static TextJoiner`	`removingEmptyStrings(boolean removeEmptyStrings)` Creates a builder with empty-string filtering explicitly configured.
`static TextJoiner`	`removingNulls(boolean removeNulls)` Creates a builder with null-filtering explicitly configured.
`TextJoiner`	`separateBy(char separator)` Convenience alias for single-character separator.
`TextJoiner`	`separateBy(java.lang.String separator)` Convenience alias for `withSeparator(String)`.
`static TextJoiner`	`separatedBy(char separator)` Convenience alias for single-character separator.
`static TextJoiner`	`separatedBy(java.lang.String separator)` Creates a builder preconfigured with a specific delimiter to save on boilerplate code.
`static TextJoiner`	`surroundedWith(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> surrounder)` Creates a builder preconfigured with dynamic surrounding logic.
`static TextJoiner`	`surroundedWith(char surround)` Convenience alias for single-character surrounds.
`static TextJoiner`	`surroundedWith(java.lang.String surround)` Creates a builder preconfigured to surround each element by prepending and appending this exact string.
`TextJoiner`	`surroundWith(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> surrounder)` Configures dynamic surrounding based on the element value and current separator.
`TextJoiner`	`surroundWith(char surround)` Convenience alias for single-character surrounds.
`TextJoiner`	`surroundWith(java.lang.String surround)` Surrounds each element by prepending AND appending this exact string.
`static java.lang.String`	`unescape(java.lang.String str)` Unescapes strings that were escaped using `escape(String, String)` without regex overhead.
`TextJoiner`	`withDefault(java.lang.String defaultString)` Fallback string returned when the input collection or array is null or empty.
`TextJoiner`	`withEscaper(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> escaper)` Supplies the custom escaping function `(value, separator) -> escapedValue`.
`static TextJoiner`	`withoutDuplicates()` Creates a builder configured to deduplicate elements while preserving insertion order.
`static TextJoiner`	`withoutEmptyStrings()` Creates a builder configured to drop empty, whitespace-only, and null strings during iteration.
`static TextJoiner`	`withoutNulls()` Creates a builder configured to drop literal `null` values during iteration.
`TextJoiner`	`withPrefix(java.lang.String prefix)` Prepends this string once at the beginning of the rendered output.
`TextJoiner`	`withSeparator(char separator)` Convenience alias for single-character separator.
`TextJoiner`	`withSeparator(java.lang.String separator)` Sets the delimiter inserted between elements.

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

- Field Detail
  - DEFAULT_SEPARATOR
```
public static final java.lang.String DEFAULT_SEPARATOR
```
    The default separator for String joining and splitting: ", "
    
    See Also:
    
    Constant Field Values
- Method Detail
  - escape
```
public static java.lang.String escape(java.lang.String str,
                                      java.lang.String charsToEscape)
```
    Escapes backslashes and any character present in charsToEscape by prefixing them with a single backslash ('\').
    
    Parameters:
    
    str - the string to escape
    
    charsToEscape - characters that need escaping (e.g. delimiters)
    
    Returns:
    
    the escaped string, or the input string if null/empty
    
    Throws:
    
    java.lang.NullPointerException - if str is null.
  - unescape
```
public static java.lang.String unescape(java.lang.String str)
```
    Unescapes strings that were escaped using escape(String, String) without regex overhead.
    
    Parameters:
    
    str - string to unescape
    
    Returns:
    
    unescaped string, or original if null/empty
    
    Throws:
    
    java.lang.NullPointerException - if str is null.
  - create
```
public static TextJoiner create()
```
    Creates a new fluent TextJoiner instance with default settings.
  - separatedBy
```
public static TextJoiner separatedBy(java.lang.String separator)
```
    Creates a builder preconfigured with a specific delimiter to save on boilerplate code. Equivalent to TextJoiner.create().withSeparator(separator).
  - separatedBy
```
public static TextJoiner separatedBy(char separator)
```
    Convenience alias for single-character separator.
  - on
```
public static TextJoiner on(java.lang.String separator)
```
    Convenience alias for separatedBy(String).
  - on
```
public static TextJoiner on(char separator)
```
    Convenience alias for single-character delimiters.
  - defaultingTo
```
public static TextJoiner defaultingTo(java.lang.String defaultString)
```
    Creates a builder preconfigured with a fallback string returned when the input collection or array is null or empty. Equivalent to TextJoiner.create().withDefault(defaultString).
  - surroundedWith
```
public static TextJoiner surroundedWith(java.lang.String surround)
```
    Creates a builder preconfigured to surround each element by prepending and appending this exact string. Equivalent to TextJoiner.create().surroundWith(surround).
  - surroundedWith
```
public static TextJoiner surroundedWith(char surround)
```
    Convenience alias for single-character surrounds.
  - surroundedWith
```
public static TextJoiner surroundedWith(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> surrounder)
```
    Creates a builder preconfigured with dynamic surrounding logic. Equivalent to TextJoiner.create().surroundWith(surrounder).
  - prefixedWith
```
public static TextJoiner prefixedWith(java.lang.String prefix)
```
    Creates a builder preconfigured to prepend this string once at the beginning of the rendered output. Equivalent to TextJoiner.create().withPrefix(prefix).
  - escaping
```
public static TextJoiner escaping(boolean escape)
```
    Creates a builder with escaping explicitly enabled or disabled. Equivalent to TextJoiner.create().escape(escape).
  - escapingWith
```
public static TextJoiner escapingWith(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> escaper)
```
    Creates a builder preconfigured with a custom escaping function. Equivalent to TextJoiner.create().withEscaper(escaper).
  - withoutNulls
```
public static TextJoiner withoutNulls()
```
    Creates a builder configured to drop literal null values during iteration. Equivalent to TextJoiner.create().removeNulls(true).
  - removingNulls
```
public static TextJoiner removingNulls(boolean removeNulls)
```
    Creates a builder with null-filtering explicitly configured. Equivalent to TextJoiner.create().removeNulls(removeNulls).
  - withoutEmptyStrings
```
public static TextJoiner withoutEmptyStrings()
```
    Creates a builder configured to drop empty, whitespace-only, and null strings during iteration. Equivalent to TextJoiner.create().removeEmptyStrings(true).
  - removingEmptyStrings
```
public static TextJoiner removingEmptyStrings(boolean removeEmptyStrings)
```
    Creates a builder with empty-string filtering explicitly configured. Equivalent to TextJoiner.create().removeEmptyStrings(removeEmptyStrings).
  - withoutDuplicates
```
public static TextJoiner withoutDuplicates()
```
    Creates a builder configured to deduplicate elements while preserving insertion order. Equivalent to TextJoiner.create().removeDuplicates(true).
  - removingDuplicates
```
public static TextJoiner removingDuplicates(boolean removeDuplicates)
```
    Creates a builder with deduplication explicitly configured. Equivalent to TextJoiner.create().removeDuplicates(removeDuplicates).
  - joinAll
```
public static java.lang.String joinAll(java.util.Collection<?> col)
```
    Joins collection elements using default delimiter (", ").
  - joinAll
```
public static java.lang.String joinAll(java.lang.Object[] array)
```
    Joins array elements using default delimiter (", ").
  - joinAll
```
public static java.lang.String joinAll(java.lang.String[] array)
```
    Joins array elements using default delimiter (", ").
  - withSeparator
```
public TextJoiner withSeparator(java.lang.String separator)
```
    Sets the delimiter inserted between elements. Default is ", ".
  - withSeparator
```
public TextJoiner withSeparator(char separator)
```
    Convenience alias for single-character separator.
  - separateBy
```
public TextJoiner separateBy(java.lang.String separator)
```
    Convenience alias for withSeparator(String).
  - separateBy
```
public TextJoiner separateBy(char separator)
```
    Convenience alias for single-character separator.
  - withDefault
```
public TextJoiner withDefault(java.lang.String defaultString)
```
    Fallback string returned when the input collection or array is null or empty.
  - surroundWith
```
public TextJoiner surroundWith(java.lang.String surround)
```
    Surrounds each element by prepending AND appending this exact string.
  - surroundWith
```
public TextJoiner surroundWith(char surround)
```
    Convenience alias for single-character surrounds.
  - surroundWith
```
public TextJoiner surroundWith(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> surrounder)
```
    Configures dynamic surrounding based on the element value and current separator. Useful for formats like CSV where quoting depends on content or delimiter presence.
  - withPrefix
```
public TextJoiner withPrefix(java.lang.String prefix)
```
    Prepends this string once at the beginning of the rendered output.
  - escape
```
public TextJoiner escape(boolean escape)
```
    Configures whether escaping is enabled (default is true).
  - withEscaper
```
public TextJoiner withEscaper(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.String> escaper)
```
    Supplies the custom escaping function (value, separator) -> escapedValue.
  - removeNulls
```
public TextJoiner removeNulls(boolean removeNulls)
```
    Drops literal null values during iteration.
  - removeEmptyStrings
```
public TextJoiner removeEmptyStrings(boolean removeEmptyStrings)
```
    Drops empty, whitespace-only, and null strings during iteration (equivalent to StringUtils.isBlank).
  - removeDuplicates
```
public TextJoiner removeDuplicates(boolean removeDuplicates)
```
    Deduplicates elements while preserving insertion order (first-seen wins).
  - join
```
public java.lang.String join(java.util.Collection<?> col)
```
  - join
```
public java.lang.String join(java.lang.Object[] array)
```
  - join
```
public java.lang.String join(java.lang.String[] array)
```
  - joinTwo
```
public java.lang.String joinTwo(java.lang.String s1,
                                java.lang.String s2)
```
    Specialized joiner for 2 strings adhering to the contract: returns null if both inputs are null.
  - joinLastDifferent
```
public static java.lang.String joinLastDifferent(java.lang.String[] strs,
                                                 java.lang.String lastSep,
                                                 java.lang.String sep)
```
    Joins elements for natural language output where the final separator differs. Example: ["Tom", "Dick", "Harry"] -> "Tom, Dick and Harry".
  - appendTo
```
public void appendTo(java.lang.StringBuilder sb,
                     java.util.Collection<?> collection)
```

Class TextJoiner

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SEPARATOR

Method Detail

escape

unescape

create

separatedBy

separatedBy

on

on

defaultingTo

surroundedWith

surroundedWith

surroundedWith

prefixedWith

escaping

escapingWith

withoutNulls

removingNulls

withoutEmptyStrings

removingEmptyStrings

withoutDuplicates

removingDuplicates

joinAll

joinAll

joinAll

withSeparator

withSeparator

separateBy

separateBy

withDefault

surroundWith

surroundWith

surroundWith

withPrefix

escape

withEscaper

removeNulls

removeEmptyStrings

removeDuplicates

join

join

join

joinTwo

joinLastDifferent

appendTo