StrJoiner (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.text.StrJoiner

All Implemented Interfaces:

Serializable, Appendable
```
public class StrJoiner
extends Object
implements Appendable, Serializable
```
字符串连接器（拼接器），通过给定的字符串和多个元素，拼接为一个字符串
相较于StringJoiner提供更加灵活的配置，包括：
- 支持任意Appendable接口实现
- 支持每个元素单独wrap
- 支持自定义null的处理逻辑
- 支持自定义默认结果
Since:

5.7.2

Author:

looly

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StrJoiner.NullMode
null处理的模式

Nested Classes
Modifier and Type	Class and Description
`static class`	`StrJoiner.NullMode` `null`处理的模式

Constructor Summary

Constructors
Constructor and Description
`StrJoiner(Appendable appendable, CharSequence delimiter)` 构造
`StrJoiner(Appendable appendable, CharSequence delimiter, CharSequence prefix, CharSequence suffix)` 构造
`StrJoiner(CharSequence delimiter)` 构造
`StrJoiner(CharSequence delimiter, CharSequence prefix, CharSequence suffix)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StrJoiner`	`append(char c)`
`StrJoiner`	`append(CharSequence csq)`
`StrJoiner`	`append(CharSequence csq, int startInclude, int endExclude)`
`<E> StrJoiner`	`append(Iterable<E> iterable, Function<? super E,? extends CharSequence> toStrFunc)` 追加`Iterator`中的元素到拼接器中
`<E> StrJoiner`	`append(Iterator<E> iterator, Function<? super E,? extends CharSequence> toStrFunc)` 追加`Iterator`中的元素到拼接器中
`<T> StrJoiner`	`append(Iterator<T> iterator)` 追加`Iterator`中的元素到拼接器中
`StrJoiner`	`append(Object obj)` 追加对象到拼接器中
`<T> StrJoiner`	`append(T[] array)` 追加数组中的元素到拼接器中
`<T> StrJoiner`	`append(T[] array, Function<T,? extends CharSequence> toStrFunc)` 追加数组中的元素到拼接器中
`int`	`length()` 长度长度计算方式为prefix + suffix + content 此方法结果与toString().length()一致。
`StrJoiner`	`merge(StrJoiner strJoiner)` 合并一个StrJoiner 到当前的StrJoiner 合并规则为，在尾部直接追加，当存在`prefix`时，如果`wrapElement`为`false`，则去除之。
`static StrJoiner`	`of(CharSequence delimiter)` 使用指定分隔符创建StrJoiner
`static StrJoiner`	`of(CharSequence delimiter, CharSequence prefix, CharSequence suffix)` 使用指定分隔符创建StrJoiner
`static StrJoiner`	`of(StrJoiner joiner)` 根据已有StrJoiner配置新建一个新的StrJoiner
`StrJoiner`	`setDelimiter(CharSequence delimiter)` 设置分隔符
`StrJoiner`	`setEmptyResult(String emptyResult)` 设置当没有任何元素加入时，默认返回的字符串，默认""
`StrJoiner`	`setNullMode(StrJoiner.NullMode nullMode)` 设置`null`元素处理逻辑
`StrJoiner`	`setPrefix(CharSequence prefix)` 设置前缀
`StrJoiner`	`setSuffix(CharSequence suffix)` 设置后缀
`StrJoiner`	`setWrapElement(boolean wrapElement)` 设置前缀和后缀是否包装每个元素
`String`	`toString()`

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

- Constructor Detail
  - StrJoiner
```
public StrJoiner(CharSequence delimiter)
```
    构造
    
    Parameters:
    
    delimiter - 分隔符，null表示无连接符，直接拼接
  - StrJoiner
```
public StrJoiner(Appendable appendable,
                 CharSequence delimiter)
```
    构造
    
    Parameters:
    
    appendable - 字符串追加器，拼接的字符串都将加入到此，null使用默认StringBuilder
    
    delimiter - 分隔符，null表示无连接符，直接拼接
  - StrJoiner
```
public StrJoiner(CharSequence delimiter,
                 CharSequence prefix,
                 CharSequence suffix)
```
    构造
    
    Parameters:
    
    delimiter - 分隔符，null表示无连接符，直接拼接
    
    prefix - 前缀
    
    suffix - 后缀
  - StrJoiner
```
public StrJoiner(Appendable appendable,
                 CharSequence delimiter,
                 CharSequence prefix,
                 CharSequence suffix)
```
    构造
    
    Parameters:
    
    appendable - 字符串追加器，拼接的字符串都将加入到此，null使用默认StringBuilder
    
    delimiter - 分隔符，null表示无连接符，直接拼接
    
    prefix - 前缀
    
    suffix - 后缀
- Method Detail
  - of
```
public static StrJoiner of(StrJoiner joiner)
```
    根据已有StrJoiner配置新建一个新的StrJoiner
    
    Parameters:
    
    joiner - 已有StrJoiner
    
    Returns:
    
    新的StrJoiner，配置相同
    
    Since:
    
    5.7.12
  - of
```
public static StrJoiner of(CharSequence delimiter)
```
    使用指定分隔符创建StrJoiner
    
    Parameters:
    
    delimiter - 分隔符
    
    Returns:
    
    StrJoiner
  - of
```
public static StrJoiner of(CharSequence delimiter,
                           CharSequence prefix,
                           CharSequence suffix)
```
    使用指定分隔符创建StrJoiner
    
    Parameters:
    
    delimiter - 分隔符
    
    prefix - 前缀
    
    suffix - 后缀
    
    Returns:
    
    StrJoiner
  - setDelimiter
```
public StrJoiner setDelimiter(CharSequence delimiter)
```
    设置分隔符
    
    Parameters:
    
    delimiter - 分隔符
    
    Returns:
    
    this
  - setPrefix
```
public StrJoiner setPrefix(CharSequence prefix)
```
    设置前缀
    
    Parameters:
    
    prefix - 前缀
    
    Returns:
    
    this
  - setSuffix
```
public StrJoiner setSuffix(CharSequence suffix)
```
    设置后缀
    
    Parameters:
    
    suffix - 后缀
    
    Returns:
    
    this
  - setWrapElement
```
public StrJoiner setWrapElement(boolean wrapElement)
```
    设置前缀和后缀是否包装每个元素
    
    Parameters:
    
    wrapElement - true表示包装每个元素，false包装整个字符串
    
    Returns:
    
    this
  - setNullMode
```
public StrJoiner setNullMode(StrJoiner.NullMode nullMode)
```
    设置null元素处理逻辑
    
    Parameters:
    
    nullMode - 逻辑枚举，可选忽略、转换为""或转换为null字符串
    
    Returns:
    
    this
  - setEmptyResult
```
public StrJoiner setEmptyResult(String emptyResult)
```
    设置当没有任何元素加入时，默认返回的字符串，默认""
    
    Parameters:
    
    emptyResult - 默认字符串
    
    Returns:
    
    this
  - append
```
public StrJoiner append(Object obj)
```
    追加对象到拼接器中
    
    Parameters:
    
    obj - 对象，支持数组、集合等
    
    Returns:
    
    this
  - append
```
public <T> StrJoiner append(T[] array)
```
    追加数组中的元素到拼接器中
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    array - 元素数组
    
    Returns:
    
    this
  - append
```
public <T> StrJoiner append(Iterator<T> iterator)
```
    追加Iterator中的元素到拼接器中
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    iterator - 元素列表
    
    Returns:
    
    this
  - append
```
public <T> StrJoiner append(T[] array,
                            Function<T,? extends CharSequence> toStrFunc)
```
    追加数组中的元素到拼接器中
    
    Type Parameters:
    
    T - 元素类型
    
    Parameters:
    
    array - 元素数组
    
    toStrFunc - 元素对象转换为字符串的函数
    
    Returns:
    
    this
  - append
```
public <E> StrJoiner append(Iterable<E> iterable,
                            Function<? super E,? extends CharSequence> toStrFunc)
```
    追加Iterator中的元素到拼接器中
    
    Type Parameters:
    
    E - 元素类型
    
    Parameters:
    
    iterable - 元素列表
    
    toStrFunc - 元素对象转换为字符串的函数
    
    Returns:
    
    this
  - append
```
public <E> StrJoiner append(Iterator<E> iterator,
                            Function<? super E,? extends CharSequence> toStrFunc)
```
    追加Iterator中的元素到拼接器中
    
    Type Parameters:
    
    E - 元素类型
    
    Parameters:
    
    iterator - 元素列表
    
    toStrFunc - 元素对象转换为字符串的函数
    
    Returns:
    
    this
  - append
```
public StrJoiner append(CharSequence csq)
```
    Specified by:
    
    append in interface Appendable
  - append
```
public StrJoiner append(CharSequence csq,
                        int startInclude,
                        int endExclude)
```
    Specified by:
    
    append in interface Appendable
  - append
```
public StrJoiner append(char c)
```
    Specified by:
    
    append in interface Appendable
  - merge
```
public StrJoiner merge(StrJoiner strJoiner)
```
    合并一个StrJoiner 到当前的StrJoiner
    合并规则为，在尾部直接追加，当存在prefix时，如果wrapElement为false，则去除之。
    
    Parameters:
    
    strJoiner - 其他的StrJoiner
    
    Returns:
    
    this
    
    Since:
    
    5.7.22
  - length
```
public int length()
```
    长度
    长度计算方式为prefix + suffix + content
    此方法结果与toString().length()一致。
    
    Returns:
    
    长度，如果结果为null，返回-1
    
    Since:
    
    5.7.22
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StrJoiner

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StrJoiner

StrJoiner

StrJoiner

StrJoiner

Method Detail

of

of

of

setDelimiter

setPrefix

setSuffix

setWrapElement

setNullMode

setEmptyResult

append

append

append

append

append

append

append

append

append

merge

length

toString