forked from plusone/plusone-commons
删除意义不大的 MapWrapper
parent
1f8036e170
commit
8411e75274
|
|
@ -1,234 +0,0 @@
|
|||
/*
|
||||
* Copyright 2023-2024 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package xyz.zhouxy.plusone.commons.collection;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
import java.util.Set;
|
||||
import java.util.function.Consumer;
|
||||
import java.util.function.Function;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
import com.google.common.annotations.Beta;
|
||||
|
||||
import xyz.zhouxy.plusone.commons.util.AssertTools;
|
||||
|
||||
/**
|
||||
* AbstractMapWrapper
|
||||
*
|
||||
* <p>
|
||||
* 包装了一个 {@link Map}。
|
||||
* 主要在于获取值时，如果 Key 不存在，是抛出异常；如果 Key 存在，则将 value 包装在 {@link Optional} 中 返回。
|
||||
* 此外可以定义 Key 和 Value 的检查规则。
|
||||
* </p>
|
||||
*
|
||||
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
@Beta
|
||||
public abstract class AbstractMapWrapper<K, V, T extends AbstractMapWrapper<K, V, T>> {
|
||||
|
||||
private final Map<K, V> map;
|
||||
private final Consumer<K> keyChecker;
|
||||
private final Consumer<V> valueChecker;
|
||||
|
||||
protected AbstractMapWrapper(Map<K, V> map,
|
||||
@Nullable Consumer<K> keyChecker,
|
||||
@Nullable Consumer<V> valueChecker) {
|
||||
this.map = map;
|
||||
this.keyChecker = keyChecker;
|
||||
this.valueChecker = valueChecker;
|
||||
}
|
||||
|
||||
public final T put(K key, V value) {
|
||||
if (this.keyChecker != null) {
|
||||
this.keyChecker.accept(key);
|
||||
}
|
||||
if (this.valueChecker != null) {
|
||||
this.valueChecker.accept(value);
|
||||
}
|
||||
this.map.put(key, value);
|
||||
return getSelf();
|
||||
}
|
||||
|
||||
public final T putAll(Map<? extends K, ? extends V> m) {
|
||||
m.forEach(this::put);
|
||||
return getSelf();
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取 {@code map} 中的值。如果 {@code key} 不存在，则抛出异常。
|
||||
* 将 {@code value}（可为 {@code null}）装进 {@link Optional} 中后返回。
|
||||
* <i>为了这碟醋包的这盘饺子。</i>
|
||||
*
|
||||
* @param key 键
|
||||
* @return 可缺失的值
|
||||
* @throws IllegalArgumentException key 不存在时抛出。
|
||||
*/
|
||||
@Nonnull
|
||||
public Optional<V> get(K key) {
|
||||
AssertTools.checkArgument(this.map.containsKey(key), "Key does not exist");
|
||||
return Optional.ofNullable(this.map.get(key));
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
public final <R> Optional<R> getAndConvert(K key) {
|
||||
return get(key).map(v -> (R) v);
|
||||
}
|
||||
|
||||
public final <R> Optional<R> getAndConvert(K key, Function<V, R> mapper) {
|
||||
return get(key).map(mapper);
|
||||
}
|
||||
|
||||
public final boolean containsKey(Object key) {
|
||||
return this.map.containsKey(key);
|
||||
}
|
||||
|
||||
public final int size() {
|
||||
return this.map.size();
|
||||
}
|
||||
|
||||
public final Set<K> keySet() {
|
||||
return this.map.keySet();
|
||||
}
|
||||
|
||||
public final Collection<V> values() {
|
||||
return this.map.values();
|
||||
}
|
||||
|
||||
public final Set<Entry<K, V>> entrySet() {
|
||||
return this.map.entrySet();
|
||||
}
|
||||
|
||||
public final void clear() {
|
||||
this.map.clear();
|
||||
}
|
||||
|
||||
public final boolean containsValue(Object value) {
|
||||
return this.map.containsValue(value);
|
||||
}
|
||||
|
||||
public final boolean isEmpty() {
|
||||
return this.map.isEmpty();
|
||||
}
|
||||
|
||||
public final V remove(Object key) {
|
||||
return this.map.remove(key);
|
||||
}
|
||||
|
||||
public final V putIfAbsent(K key, V value) {
|
||||
if (this.keyChecker != null) {
|
||||
this.keyChecker.accept(key);
|
||||
}
|
||||
if (this.valueChecker != null) {
|
||||
this.valueChecker.accept(value);
|
||||
}
|
||||
return this.map.putIfAbsent(key, value);
|
||||
}
|
||||
|
||||
public final V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) {
|
||||
if (this.keyChecker != null) {
|
||||
this.keyChecker.accept(key);
|
||||
}
|
||||
Function<? super K, ? extends V> func = (K k) -> {
|
||||
V value = mappingFunction.apply(k);
|
||||
if (this.valueChecker != null) {
|
||||
this.valueChecker.accept(value);
|
||||
}
|
||||
return value;
|
||||
};
|
||||
return this.map.computeIfAbsent(key, func);
|
||||
}
|
||||
|
||||
public final Map<K, V> exportMap() {
|
||||
return this.map;
|
||||
}
|
||||
|
||||
public final Map<K, V> exportUnmodifiableMap() {
|
||||
return Collections.unmodifiableMap(this.map);
|
||||
}
|
||||
|
||||
protected abstract T getSelf();
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return this.map.toString();
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return Objects.hash(map);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
if (this == obj)
|
||||
return true;
|
||||
if (obj == null)
|
||||
return false;
|
||||
if (getClass() != obj.getClass())
|
||||
return false;
|
||||
AbstractMapWrapper<?, ?, ?> other = (AbstractMapWrapper<?, ?, ?>) obj;
|
||||
return Objects.equals(map, other.map);
|
||||
}
|
||||
|
||||
public abstract static class Builder<K, V, T extends AbstractMapWrapper<K, V, T>> {
|
||||
protected final Map<K, V> map;
|
||||
protected Consumer<K> keyChecker;
|
||||
protected Consumer<V> valueChecker;
|
||||
|
||||
protected Builder(Map<K, V> map) {
|
||||
this.map = map;
|
||||
}
|
||||
|
||||
public Builder<K, V, T> keyChecker(@Nullable Consumer<K> keyChecker) {
|
||||
this.keyChecker = keyChecker;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Builder<K, V, T> valueChecker(@Nullable Consumer<V> valueChecker) {
|
||||
this.valueChecker = valueChecker;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Builder<K, V, T> put(K key, V value) {
|
||||
if (this.keyChecker != null) {
|
||||
this.keyChecker.accept(key);
|
||||
}
|
||||
if (this.valueChecker != null) {
|
||||
this.valueChecker.accept(value);
|
||||
}
|
||||
this.map.put(key, value);
|
||||
return this;
|
||||
}
|
||||
|
||||
public Builder<K, V, T> putAll(Map<? extends K, ? extends V> m) {
|
||||
m.forEach(this::put);
|
||||
return this;
|
||||
}
|
||||
|
||||
public abstract T build();
|
||||
|
||||
public abstract T buildUnmodifiableMap();
|
||||
}
|
||||
}
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
/*
|
||||
* Copyright 2023-2024 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package xyz.zhouxy.plusone.commons.collection;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.Comparator;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.SortedMap;
|
||||
import java.util.TreeMap;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
import com.google.common.annotations.Beta;
|
||||
|
||||
/**
|
||||
* MapWrapper
|
||||
*
|
||||
* <p>
|
||||
* Map 包装器的默认实现
|
||||
* </p>
|
||||
*
|
||||
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||
* @since 0.1.0
|
||||
*/
|
||||
@Beta
|
||||
public final class MapWrapper<K, V> extends AbstractMapWrapper<K, V, MapWrapper<K, V>> {
|
||||
|
||||
private MapWrapper(Map<K, V> map, Consumer<K> keyChecker, Consumer<V> valueChecker) {
|
||||
super(map, keyChecker, valueChecker);
|
||||
}
|
||||
|
||||
public static <K, V> Builder<K, V> wrap(Map<K, V> map) {
|
||||
return new Builder<>(map);
|
||||
}
|
||||
|
||||
public static <K, V> Builder<K, V> wrapHashMap() {
|
||||
return new Builder<>(new HashMap<>());
|
||||
}
|
||||
|
||||
public static <K, V> Builder<K, V> wrapHashMap(int initialCapacity) {
|
||||
return new Builder<>(new HashMap<>(initialCapacity));
|
||||
}
|
||||
|
||||
public static <K, V> Builder<K, V> wrapHashMap(int initialCapacity, float loadFactor) {
|
||||
return new Builder<>(new HashMap<>(initialCapacity, loadFactor));
|
||||
}
|
||||
|
||||
public static <K extends Comparable<? super K>, V> Builder<K, V> wrapTreeMap() {
|
||||
return new Builder<>(new TreeMap<>());
|
||||
}
|
||||
|
||||
public static <K, V> Builder<K, V> wrapTreeMap(SortedMap<K, ? extends V> m) {
|
||||
return new Builder<>(new TreeMap<>(m));
|
||||
}
|
||||
|
||||
public static <K, V> Builder<K, V> wrapTreeMap(Comparator<? super K> comparator) {
|
||||
return new Builder<>(new TreeMap<>(comparator));
|
||||
}
|
||||
|
||||
public static final class Builder<K, V> extends AbstractMapWrapper.Builder<K, V, MapWrapper<K, V>> {
|
||||
|
||||
private Builder(Map<K, V> map) {
|
||||
super(map);
|
||||
}
|
||||
|
||||
@Override
|
||||
public MapWrapper<K, V> build() {
|
||||
return new MapWrapper<>(map, keyChecker, valueChecker);
|
||||
}
|
||||
|
||||
@Override
|
||||
public MapWrapper<K, V> buildUnmodifiableMap() {
|
||||
return new MapWrapper<>(Collections.unmodifiableMap(map), keyChecker, valueChecker);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
protected MapWrapper<K, V> getSelf() {
|
||||
return this;
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue