MapModifier (Plusone Commons 1.1.0-RC1 API)

java.lang.Object
- xyz.zhouxy.plusone.commons.collection.MapModifier<K,V>

@Beta
public class MapModifier<K,V>
extends Object

Map 修改器

封装一系列对 Map 数据的修改操作，修改 Map 的数据。可以用于 Map 的数据初始化等操作。

 // MapModifier
 MapModifier<String, Object> modifier = new MapModifier<String, Object>()
     .putAll(commonProperties)
     .put("username", "Ben")
     .put("accountStatus", LOCKED);

 // 从 Supplier 中获取 Map，并修改数据
 Map<String, Object> map = modifier.getAndModify(HashMap::new);

 // 可以灵活使用不同 Map 类型的不同构造器
 Map<String, Object> map = modifier.getAndModify(() -> new HashMap<>(8));
 Map<String, Object> map = modifier.getAndModify(() -> new HashMap<>(anotherMap));
 Map<String, Object> map = modifier.getAndModify(TreeMap::new);
 Map<String, Object> map = modifier.getAndModify(ConcurrentHashMap::new);

 // 修改已有的 Map
 modifier.modify(map);

 // 创建一个有初始化数据的不可变的 Map
 Map<String, Object> map = modifier.getUnmodifiableMap();

 // 链式调用创建并初始化数据
 Map<String, Object> map = new MapModifier<String, Object>()
     .putAll(commonProperties)
     .put("username", "Ben")
     .put("accountStatus", LOCKED)
     .getAndModify(HashMap::new);

Since:: 1.1.0
Author:: ZhouXY108

Constructor Summary

Constructors
Constructor and Description

MapModifier()
创建一个空的 MapModifier

MapModifier(int initialCapacity)

Constructors
Constructor and Description
`MapModifier()` 创建一个空的 MapModifier
`MapModifier(int initialCapacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapModifier<K,V>`	`clear()` 清空 `map`
`MapModifier<K,V>`	`computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)` 当 `key` 不存在时，计算对应的值，并添加到 `map` 中。
`MapModifier<K,V>`	`computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)` 当 `key` 存在时，计算对应的值，并添加到 `map` 中。
`<T extends Map<K,V>> T`	`getAndModify(Supplier<T> mapSupplier)` 修改 `map`
`Map<K,V>`	`getConcurrentHashMap()` 获取 `ConcurrentHashMap`
`Map<K,V>`	`getHashMap()` 获取 `HashMap`
`Map<K,V>`	`getLinkedHashMap()` 获取 `LinkedHashMap`
`int`	`getOperatorCount()` 获取操作数量
`Map<K,V>`	`getTreeMap()` 获取 `TreeMap`
`Map<K,V>`	`getUnmodifiableMap()` 创建一个有初始化数据的不可变的 `Map`
`boolean`	`hasOperations()` 是否有操作
`<T extends Map<K,V>> void`	`modify(T map)` 修改 `map`
`MapModifier<K,V>`	`put(K key, V value)` 添加一个键值对。
`MapModifier<K,V>`	`putAll(Map<? extends K,? extends V> otherMap)` 添加多个键值对。
`MapModifier<K,V>`	`putIfAbsent(K key, V value)` 添加一个键值对，如果 key 已经存在，则不添加。
`MapModifier<K,V>`	`remove(K key)` 删除 `key`。
`String`	`toString()`

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

- Constructor Detail
  - MapModifier
```
public MapModifier()
```
    创建一个空的 MapModifier
  - MapModifier
```
public MapModifier(int initialCapacity)
```
- Method Detail
  - put
```
public MapModifier<K,V> put(@Nullable
                            K key,
                            @Nullable
                            V value)
```
    添加一个键值对。
    注意：键值对是否允许为 null，由最终作用的 Map 类型决定。
    
    Parameters:
    
    key - 要添加的 key
    
    value - 要添加的 value
    
    Returns:
    
    MapModifier
  - putIfAbsent
```
public MapModifier<K,V> putIfAbsent(@Nullable
                                    K key,
                                    @Nullable
                                    V value)
```
    添加一个键值对，如果 key 已经存在，则不添加。
    注意：键值对是否允许为 null，由最终作用的 Map 类型决定。
    
    Parameters:
    
    key - 要添加的 key
    
    value - 要添加的 value
    
    Returns:
    
    MapModifier
  - putAll
```
public MapModifier<K,V> putAll(@Nullable
                               Map<? extends K,? extends V> otherMap)
```
    添加多个键值对。
    注意：键值对是否允许为 null，由最终作用的 Map 类型决定。
    
    Parameters:
    
    otherMap - 要添加的键值对集合。如果为 null，则什么都不做。
    
    Returns:
    
    MapModifier
  - computeIfAbsent
```
public MapModifier<K,V> computeIfAbsent(K key,
                                        Function<? super K,? extends V> mappingFunction)
```
    当 key 不存在时，计算对应的值，并添加到 map 中。
    调用 Map.computeIfAbsent(Object, Function)。
    注意：键值对是否允许为 null，由最终作用的 Map 类型决定。
    
    Parameters:
    
    key - 要添加的 key
    
    mappingFunction - 计算 key 对应的值
    
    Returns:
    
    MapModifier
  - computeIfPresent
```
public MapModifier<K,V> computeIfPresent(K key,
                                         BiFunction<? super K,? super V,? extends V> remappingFunction)
```
    当 key 存在时，计算对应的值，并添加到 map 中。
    调用 Map.computeIfPresent(Object, BiFunction)。
    注意：键值对是否允许为 null，由最终作用的 Map 类型决定。
    
    Parameters:
    
    key - 要添加的 key
    
    remappingFunction - 计算 key 对应的值
    
    Returns:
    
    MapModifier
  - remove
```
public MapModifier<K,V> remove(K key)
```
    删除 key。
    注意：key 是否允许为 null，由最终作用的 Map 类型决定。
    
    Parameters:
    
    key - 要删除的 key
    
    Returns:
    
    MapModifier
  - clear
```
public MapModifier<K,V> clear()
```
    清空 map
    
    Returns:
    
    MapModifier
  - modify
```
public <T extends Map<K,V>> void modify(@Nullable
                                        T map)
```
    修改 map
    
    Parameters:
    
    map - 要修改的 map
  - getAndModify
```
@CheckForNull
public <T extends Map<K,V>> T getAndModify(Supplier<T> mapSupplier)
```
    修改 map
    
    Parameters:
    
    mapSupplier - map 的 Supplier
    
    Returns:
    
    修改后的 map。当从 mapSupplier 获取的 map 为 null 时，返回 null。
  - getHashMap
```
public Map<K,V> getHashMap()
```
    获取 HashMap
    
    Returns:
    
    HashMap
  - getLinkedHashMap
```
public Map<K,V> getLinkedHashMap()
```
    获取 LinkedHashMap
    
    Returns:
    
    LinkedHashMap
  - getTreeMap
```
public Map<K,V> getTreeMap()
```
    获取 TreeMap
    
    Returns:
    
    TreeMap
  - getConcurrentHashMap
```
public Map<K,V> getConcurrentHashMap()
```
    获取 ConcurrentHashMap
    
    Returns:
    
    ConcurrentHashMap
  - getUnmodifiableMap
```
public Map<K,V> getUnmodifiableMap()
```
    创建一个有初始化数据的不可变的 Map
    
    Returns:
    
    不可变的 Map
  - getOperatorCount
```
public int getOperatorCount()
```
    获取操作数量
    
    Returns:
    
    操作数量
  - hasOperations
```
public boolean hasOperations()
```
    是否有操作
    
    Returns:
    
    如果有操作，则返回 true，否则返回 false
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MapModifier<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapModifier

MapModifier

Method Detail

put

putIfAbsent

putAll

computeIfAbsent

computeIfPresent

remove

clear

modify

getAndModify

getHashMap

getLinkedHashMap

getTreeMap

getConcurrentHashMap

getUnmodifiableMap

getOperatorCount

hasOperations

toString