cn.hutool.core.map.MapBuilder Maven / Gradle / Ivy
package cn.hutool.core.map;
import cn.hutool.core.builder.Builder;
import java.util.Map;
import java.util.function.Supplier;
/**
* Map创建类
*
* @param Key类型
* @param Value类型
* @since 3.1.1
*/
public class MapBuilder implements Builder> {
private static final long serialVersionUID = 1L;
private final Map map;
/**
* 创建Builder，默认HashMap实现
*
* @param Key类型
* @param Value类型
* @return MapBuilder
* @since 5.3.0
*/
public static MapBuilder create() {
return create(false);
}
/**
* 创建Builder
*
* @param Key类型
* @param Value类型
* @param isLinked true创建LinkedHashMap，false创建HashMap
* @return MapBuilder
* @since 5.3.0
*/
public static MapBuilder create(boolean isLinked) {
return create(MapUtil.newHashMap(isLinked));
}
/**
* 创建Builder
*
* @param Key类型
* @param Value类型
* @param map Map实体类
* @return MapBuilder
* @since 3.2.3
*/
public static MapBuilder create(Map map) {
return new MapBuilder<>(map);
}
/**
* 链式Map创建类
*
* @param map 要使用的Map实现类
*/
public MapBuilder(Map map) {
this.map = map;
}
/**
* 链式Map创建
*
* @param k Key类型
* @param v Value类型
* @return 当前类
*/
public MapBuilder put(K k, V v) {
map.put(k, v);
return this;
}
/**
* 链式Map创建
*
* @param condition put条件
* @param k Key类型
* @param v Value类型
* @return 当前类
* @since 5.7.5
*/
public MapBuilder put(boolean condition, K k, V v) {
if (condition) {
put(k, v);
}
return this;
}
/**
* 链式Map创建
*
* @param condition put条件
* @param k Key类型
* @param supplier Value类型结果提供方
* @return 当前类
* @since 5.7.5
*/
public MapBuilder put(boolean condition, K k, Supplier supplier) {
if (condition) {
put(k, supplier.get());
}
return this;
}
/**
* 链式Map创建
*
* @param map 合并map
* @return 当前类
*/
public MapBuilder putAll(Map map) {
this.map.putAll(map);
return this;
}
/**
* 清空Map
*
* @return this
* @since 5.7.23
*/
public MapBuilder clear() {
this.map.clear();
return this;
}
/**
* 创建后的map
*
* @return 创建后的map
*/
public Map map() {
return map;
}
/**
* 创建后的map
*
* @return 创建后的map
* @since 3.3.0
*/
@Override
public Map build() {
return map();
}
/**
* 将map转成字符串
*
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @return 连接字符串
*/
public String join(String separator, final String keyValueSeparator) {
return MapUtil.join(this.map, separator, keyValueSeparator);
}
/**
* 将map转成字符串
*
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @return 连接后的字符串
*/
public String joinIgnoreNull(String separator, final String keyValueSeparator) {
return MapUtil.joinIgnoreNull(this.map, separator, keyValueSeparator);
}
/**
* 将map转成字符串
*
* @param separator entry之间的连接符
* @param keyValueSeparator kv之间的连接符
* @param isIgnoreNull 是否忽略null的键和值
* @return 连接后的字符串
*/
public String join(String separator, final String keyValueSeparator, boolean isIgnoreNull) {
return MapUtil.join(this.map, separator, keyValueSeparator, isIgnoreNull);
}
}