com.feilong.core.bean

Class ToStringConfig

java.lang.Object

com.feilong.core.bean.ToStringConfig

All Implemented Interfaces:

Serializable

public final class ToStringConfig
extends Object
implements Serializable

将 集合转成字符串,将数组转成字符串 的参数配置.

默认的规则:

1. 连接符使用DEFAULT_CONNECTOR
2. 拼接null或者empty元素
3. 如果元素是null,使用StringUtils.EMPTY替代拼接
4. 最后一个元素后面不拼接拼接符

Since:

1.4.0

Author:

feilong

See Also:

ToStringStyle, StringUtils.join(Object[], String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ToStringConfig	DEFAULT_CONFIG 默认的转换参数.
static String	DEFAULT_CONNECTOR 默认逗号连接 ",".
static ToStringConfig	IGNORE_NULL_OR_EMPTY_CONFIG 使用 DEFAULT_CONNECTOR 但是忽视 null 或者 empty 元素进行拼接的参数.

Constructor Summary

Constructors

Constructor and Description
ToStringConfig() 默认的构造函数.
ToStringConfig(String connector) Instantiates a new to string config.
ToStringConfig(String connector, boolean isJoinNullOrEmpty) Instantiates a new to string config.
ToStringConfig(String connector, boolean isJoinNullOrEmpty, String prefix) Instantiates a new to string config.

Method Summary

Methods

Modifier and Type	Method and Description
String	getConnector() 获得 连接符,默认=DEFAULT_CONNECTOR.
boolean	getIsJoinNullOrEmpty() 是否拼接null或者empty的元素,如果是true ,表示拼接,如果是false,那么拼接的时候跳过这个元素.
String	getPrefix() 获得 循环拼接元素的时候,支持给每个元素拼接一个前缀.
void	setConnector(String connector) 设置 连接符,默认=DEFAULT_CONNECTOR.
void	setIsJoinNullOrEmpty(boolean isJoinNullOrEmpty) 是否拼接null或者empty的元素,如果是true ,表示拼接,如果是false,那么拼接的时候跳过这个元素.
void	setPrefix(String prefix) 设置 循环拼接元素的时候,支持给每个元素拼接一个前缀.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTOR

public static final String DEFAULT_CONNECTOR

默认逗号连接 ",".

Since:

1.0.6

See Also:

Constant Field Values

DEFAULT_CONFIG

public static final ToStringConfig DEFAULT_CONFIG

默认的转换参数.

默认的规则:

.

1. 连接符使用DEFAULT_CONNECTOR
2. 拼接null或者empty元素
3. 如果元素是null,使用StringUtils.EMPTY替代拼接
4. 最后一个元素后面不拼接拼接符

示例:

下面是调用 ConvertUtil.toString(java.util.Collection, ToStringConfig)或者 ConvertUtil.toString(Object[], ToStringConfig)的示例

 ConvertUtil.toString(toList("feilong", "xinge"), DEFAULT_CONFIG) = "feilong,xinge";
 ConvertUtil.toString(toList("feilong", "", "xinge", null), DEFAULT_CONFIG) = "feilong,,xinge,";
 

Since:

1.10.3

See Also:

ToStringStyle.DEFAULT_STYLE

IGNORE_NULL_OR_EMPTY_CONFIG

public static final ToStringConfig IGNORE_NULL_OR_EMPTY_CONFIG

使用 DEFAULT_CONNECTOR 但是忽视 null 或者 empty 元素进行拼接的参数.

默认的规则:

.

1. 连接符使用DEFAULT_CONNECTOR
2. 不拼接null或者empty元素
3. 最后一个元素后面不拼接拼接符

示例:

下面是调用 ConvertUtil.toString(java.util.Collection, ToStringConfig)或者 ConvertUtil.toString(Object[], ToStringConfig)的示例

 ConvertUtil.toString(toList("feilong", "xinge"), IGNORE_NULL_OR_EMPTY_CONFIG) = "feilong,xinge";
 ConvertUtil.toString(toList("feilong", "", "xinge", null), IGNORE_NULL_OR_EMPTY_CONFIG) = "feilong,xinge";
 

Since:

1.10.3

See Also:

ToStringStyle.DEFAULT_STYLE

Constructor Detail

ToStringConfig

public ToStringConfig()

默认的构造函数.

默认的规则:

.

1. 连接符使用DEFAULT_CONNECTOR
2. 拼接null或者empty元素
3. 如果元素是null,使用StringUtils.EMPTY替代拼接
4. 最后一个元素后面不拼接拼接符

ToStringConfig

public ToStringConfig(String connector)

Instantiates a new to string config.

Parameters:

connector - 连接符

ToStringConfig

public ToStringConfig(String connector,
              boolean isJoinNullOrEmpty)

Instantiates a new to string config.

Parameters:

connector - 连接符

isJoinNullOrEmpty - 是否拼接null或者empty的元素,如果是true ,表示拼接,如果是false,那么拼接的时候跳过这个元素

Since:

1.4.0

ToStringConfig

public ToStringConfig(String connector,
              boolean isJoinNullOrEmpty,
              String prefix)

Instantiates a new to string config.

Parameters:

connector - the connector

isJoinNullOrEmpty - the is join null or empty

prefix - the prefix

Since:

1.12.9

Method Detail

getConnector

public String getConnector()

获得 连接符,默认=DEFAULT_CONNECTOR.

Returns:

the connector

setConnector

public void setConnector(String connector)

设置 连接符,默认=DEFAULT_CONNECTOR.

Parameters:

connector - the connector to set

getIsJoinNullOrEmpty

public boolean getIsJoinNullOrEmpty()

是否拼接null或者empty的元素,如果是true ,表示拼接,如果是false,那么拼接的时候跳过这个元素.

Returns:

the isJoinNullOrEmpty

Since:

1.2.1

setIsJoinNullOrEmpty

public void setIsJoinNullOrEmpty(boolean isJoinNullOrEmpty)

是否拼接null或者empty的元素,如果是true ,表示拼接,如果是false,那么拼接的时候跳过这个元素.

Parameters:

isJoinNullOrEmpty - the isJoinNullOrEmpty to set

Since:

1.2.1

getPrefix

public String getPrefix()

获得 循环拼接元素的时候,支持给每个元素拼接一个前缀.

Returns:

the prefix

Since:

1.12.9

setPrefix

public void setPrefix(String prefix)

设置 循环拼接元素的时候,支持给每个元素拼接一个前缀.

Parameters:

prefix - the prefix to set

Since:

1.12.9

toString

public String toString()

Overrides:

toString in class Object