All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • cn.hutool.core.lang.Tuple Maven / Gradle / Ivy

    The newest version!
    package cn.hutool.core.lang;

import cn.hutool.core.clone.CloneSupport;
import cn.hutool.core.collection.ArrayIter;
import cn.hutool.core.collection.ListUtil;
import cn.hutool.core.util.ArrayUtil;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

/**
 * 不可变数组类型（元组），用于多值返回
    
 * 多值可以支持每个元素值类型不同
 *
 * @author Looly
 */
public class Tuple extends CloneSupport implements Iterable, Serializable {
	private static final long serialVersionUID = -7689304393482182157L;

	private final Object[] members;
	private int hashCode;
	private boolean cacheHash;

	/**
	 * 构造
	 *
	 * @param members 成员数组
	 */
	public Tuple(Object... members) {
		this.members = members;
	}

	/**
	 * 获取指定位置元素
	 *
	 * @param    返回对象类型
	 * @param index 位置
	 * @return 元素
	 */
	@SuppressWarnings("unchecked")
	public  T get(int index) {
		return (T) members[index];
	}

	/**
	 * 获得所有元素
	 *
	 * @return 获得所有元素
	 */
	public Object[] getMembers() {
		return this.members;
	}

	/**
	 * 将元组转换成列表
	 *
	 * @return 转换得到的列表
	 * @since 5.6.6
	 */
	public final List toList() {
		return ListUtil.toList(this.members);
	}

	/**
	 * 缓存Hash值，当为true时，此对象的hash值只被计算一次，常用于Tuple中的值不变时使用。
	 * 注意：当为true时，member变更对象后，hash值不会变更。
	 *
	 * @param cacheHash 是否缓存hash值
	 * @return this
	 * @since 5.2.1
	 */
	public Tuple setCacheHash(boolean cacheHash) {
		this.cacheHash = cacheHash;
		return this;
	}

	/**
	 * 得到元组的大小
	 *
	 * @return 元组的大小
	 * @since 5.6.6
	 */
	public int size() {
		return this.members.length;
	}

	/**
	 * 判断元组中是否包含某元素
	 *
	 * @param value 需要判定的元素
	 * @return 是否包含
	 * @since 5.6.6
	 */
	public boolean contains(Object value) {
		return ArrayUtil.contains(this.members, value);
	}

	/**
	 * 将元组转成流
	 *
	 * @return 流
	 * @since 5.6.6
	 */
	public final Stream stream() {
		return Arrays.stream(this.members);
	}

	/**
	 * 将元组转成并行流
	 *
	 * @return 流
	 * @since 5.6.6
	 */
	public final Stream parallelStream() {
		return StreamSupport.stream(spliterator(), true);
	}

	/**
	 * 截取元组指定部分
	 *
	 * @param start 起始位置（包括）
	 * @param end   终止位置（不包括）
	 * @return 截取得到的元组
	 * @since 5.6.6
	 */
	public final Tuple sub(final int start, final int end) {
		return new Tuple(ArrayUtil.sub(this.members, start, end));
	}

	@Override
	public int hashCode() {
		if (this.cacheHash && 0 != this.hashCode) {
			return this.hashCode;
		}
		final int prime = 31;
		int result = 1;
		result = prime * result + Arrays.deepHashCode(members);
		if (this.cacheHash) {
			this.hashCode = result;
		}
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		Tuple other = (Tuple) obj;
		return false != Arrays.deepEquals(members, other.members);
	}

	@Override
	public String toString() {
		return Arrays.toString(members);
	}

	@Override
	public Iterator iterator() {
		return new ArrayIter<>(members);
	}

	@Override
	public final Spliterator spliterator() {
		return Spliterators.spliterator(this.members, Spliterator.ORDERED);
	}
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy