cn.hutool.core.map.TransMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hutool-core Show documentation
Hutool核心，包括集合、字符串、Bean等工具
There is a newer version: 5.8.33
package cn.hutool.core.map;

import java.util.Map;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;

/**
 * 自定义键和值转换的的Map

 * 继承此类后，通过实现{@link #customKey(Object)}和{@link #customValue(Object)}，按照给定规则加入到map或获取值。
 *
 * @param  键类型
 * @param  值类型
 * @author Looly
 * @since 5.8.0
 */
public abstract class TransMap extends MapWrapper {
	private static final long serialVersionUID = 1L;

	/**
	 * 构造

	 * 通过传入一个Map从而确定Map的类型，子类需创建一个空的Map，而非传入一个已有Map，否则值可能会被修改
	 *
	 * @param mapFactory 空Map创建工厂
	 * @since 5.8.0
	 */
	public TransMap(Supplier> mapFactory) {
		super(mapFactory);
	}

	/**
	 * 构造

	 * 通过传入一个Map从而确定Map的类型，子类需创建一个空的Map，而非传入一个已有Map，否则值可能会被修改
	 *
	 * @param emptyMap Map 被包装的Map，必须为空Map，否则自定义key会无效
	 * @since 3.1.2
	 */
	public TransMap(Map emptyMap) {
		super(emptyMap);
	}

	@Override
	public V get(Object key) {
		return super.get(customKey(key));
	}

	@Override
	public V put(K key, V value) {
		return super.put(customKey(key), customValue(value));
	}

	@Override
	public void putAll(Map m) {
		m.forEach(this::put);
	}

	@Override
	public boolean containsKey(Object key) {
		return super.containsKey(customKey(key));
	}

	@Override
	public V remove(Object key) {
		return super.remove(customKey(key));
	}

	@Override
	public boolean remove(Object key, Object value) {
		return super.remove(customKey(key), customValue(value));
	}

	@Override
	public boolean replace(K key, V oldValue, V newValue) {
		return super.replace(customKey(key), customValue(oldValue), customValue(newValue));
	}

	@Override
	public V replace(K key, V value) {
		return super.replace(customKey(key), customValue(value));
	}

	//---------------------------------------------------------------------------- Override default methods start
	@Override
	public V getOrDefault(Object key, V defaultValue) {
		return super.getOrDefault(customKey(key), customValue(defaultValue));
	}

	@Override
	public V computeIfPresent(K key, BiFunction remappingFunction) {
		return super.computeIfPresent(customKey(key), (k, v) -> remappingFunction.apply(customKey(k), customValue(v)));
	}

	@Override
	public V compute(K key, BiFunction remappingFunction) {
		return super.compute(customKey(key), (k, v) -> remappingFunction.apply(customKey(k), customValue(v)));
	}

	@Override
	public V merge(K key, V value, BiFunction remappingFunction) {
		return super.merge(customKey(key), customValue(value), (v1, v2) -> remappingFunction.apply(customValue(v1), customValue(v2)));
	}

	@Override
	public V putIfAbsent(K key, V value) {
		return super.putIfAbsent(customKey(key), customValue(value));
	}

	@Override
	public V computeIfAbsent(final K key, final Function mappingFunction) {
		return super.computeIfAbsent(customKey(key), mappingFunction);
	}
	//---------------------------------------------------------------------------- Override default methods end

	/**
	 * 自定义键
	 *
	 * @param key KEY
	 * @return 自定义KEY
	 */
	protected abstract K customKey(Object key);

	/**
	 * 自定义值
	 *
	 * @param value 值
	 * @return 自定义值
	 */
	protected abstract V customValue(Object value);
}