com.livk.commons.util.Pair Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021-2024 spring-boot-extension 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 com.livk.commons.util;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.BeanProperty;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.KeyDeserializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.deser.ContextualDeserializer;
import com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer;
import com.fasterxml.jackson.databind.ser.ContextualSerializer;
import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer;
import com.fasterxml.jackson.databind.type.TypeBindings;
import java.io.IOException;
import java.io.Serial;
import java.io.Serializable;
import java.util.Map;
import java.util.function.BiFunction;
import java.util.function.Function;
import lombok.EqualsAndHashCode;
import lombok.RequiredArgsConstructor;

/**
 * 
 * 通用键值对
 * 
 *
 * @param  key type parameter
 * @param  value type parameter
 * @author livk
 */
@EqualsAndHashCode
@RequiredArgsConstructor(staticName = "of")
@JsonSerialize(using = Pair.PairJsonSerializer.class)
@JsonDeserialize(using = Pair.PairJsonDeserializer.class)
public final class Pair implements Serializable, Cloneable {

	/**
	 * 默认的空Pair
	 */
	public static final Pair EMPTY = Pair.of(null, null);

	@Serial
	private static final long serialVersionUID = -2303547536834226401L;

	/**
	 * key
	 */
	private final K key;

	/**
	 * value
	 */
	private final V value;

	/**
	 * 静态构造Map.Entry转Pair
	 * @param  key type parameter
	 * @param  value type parameter
	 * @param entry entry
	 * @return pair
	 */
	public static  Pair of(Map.Entry entry) {
		return of(entry.getKey(), entry.getValue());
	}

	/**
	 * 获取Key
	 * @return key
	 */
	public K key() {
		return key;
	}

	/**
	 * 获取value
	 * @return value
	 */
	public V value() {
		return value;
	}

	/**
	 * 转成Map
	 * @return the map
	 * @see Map#of(Object, Object)
	 */
	public Map toMap() {
		return Map.of(key, value);
	}

	/**
	 * 转成Map.Entry
	 * @return entry
	 */
	public Map.Entry toEntry() {
		return Map.entry(key, value);
	}

	/**
	 * 进行map转换
	 * @param  key转换后type
	 * @param  value转换后type
	 * @param keyFunction key function
	 * @param valueFunction value function
	 * @return pair
	 */
	public  Pair map(Function keyFunction, Function valueFunction) {
		return of(keyFunction.apply(key), valueFunction.apply(value));
	}

	/**
	 * Key进行map转换
	 * @param  key转换后type
	 * @param keyFunction key function
	 * @return pair
	 */
	public  Pair keyMap(Function keyFunction) {
		return map(keyFunction, Function.identity());
	}

	/**
	 * Value进行map转换
	 * @param  value转换后type
	 * @param valueFunction value function
	 * @return pair
	 */
	public  Pair valueMap(Function valueFunction) {
		return map(Function.identity(), valueFunction);
	}

	/**
	 * 进行flatmap转换
	 * @param  key转换后type
	 * @param  value转换后type
	 * @param biFunction bi function
	 * @return pair
	 */
	public  Pair flatMap(BiFunction> biFunction) {
		return biFunction.apply(key, value);
	}

	@SuppressWarnings("unchecked")
	@Override
	public Pair clone() {
		try {
			return (Pair) super.clone();
		}
		catch (CloneNotSupportedException e) {
			throw new AssertionError();
		}
	}

	@Override
	public String toString() {
		return "{" + key + ":" + value + "}";
	}

	/**
	 * Pair Jackson序列化工具
	 */
	static class PairJsonSerializer extends StdScalarSerializer> implements ContextualSerializer {

		private JsonSerializer