com.moon.core.util.Table Maven / Gradle / Ivy

Go to download
package com.moon.core.util;

import com.moon.core.util.function.TableConsumer;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Supplier;

/**
 * @author moonsky
 */
public interface Table {

    /**
     * 指定坐标设置值
     *
     * @param x X轴
     * @param y Y轴
     * @param z 值
     *
     * @return 旧值或 null
     */
    Z put(X x, Y y, Z z);

    /**
     * 指定坐标设置值
     *
     * @param x X轴
     * @param y Y轴
     * @param z 值
     *
     * @return 旧值或 null
     */
    Z putIfAbsent(X x, Y y, Z z);

    /**
     * 指定坐标获取值
     *
     * @param x X轴
     * @param y Y轴
     *
     * @return 存在的值或 null
     */
    Z get(Object x, Object y);

    /**
     * 获取值，或返回默认值
     *
     * @param x            namespace
     * @param y            key
     * @param defaultValue defaultValue
     *
     * @return this
     */
    default Z getOrDefault(Object x, Object y, Z defaultValue) {
        Z value = get(x, y);
        return value == null ? defaultValue : value;
    }

    /**
     * 获取值，或返回默认值
     *
     * @param x        namespace
     * @param y        key
     * @param supplier 默认值 getter
     *
     * @return value
     */
    default Z getOrElse(Object x, Object y, Supplier supplier) {
        Z value = get(x, y);
        return value == null ? supplier.get() : value;
    }

    /**
     * 获取值，或计算设置后返回结果
     *
     * @param x       x
     * @param y       y
     * @param mapping 计算器
     *
     * @return 原映射存在值时，返回原结果，否则返回{@code mapping}的结果
     */
    default Z computeIfAbsent(X x, Y y, BiFunction mapping) {
        Z value = get(x, y);
        if (value == null) {
            value = mapping.apply(x, y);
            put(x, y, value);
        }
        return value;
    }

    /**
     * 指定行设置值（替换）
     *
     * @param x   X轴
     * @param map 行数据
     *
     * @return 旧的行数据
     */
    Map put(X x, Map map);

    /**
     * 指定行设置值（增量）
     *
     * @param x   X轴
     * @param map 行数据
     */
    void putAll(X x, Map map);

    /**
     * 获取指定行数据
     *
     * @param x X轴
     *
     * @return 行数据
     */
    Map get(Object x);

    /**
     * 增量设置值
     *
     * @param table other table
     */
    void putAll(Table table);

    /**
     * 删除
     *
     * @param x X轴
     * @param y Y轴
     *
     * @return 值
     */
    Z remove(Object x, Object y);

    /**
     * 删除指定行
     *
     * @param x X轴
     *
     * @return 返回被删除的行数据
     */
    Map remove(Object x);

    /**
     * 是否包含值
     *
     * @param value 待测试值
     *
     * @return 是否包含
     *
     * @see Map#containsValue(Object)
     */
    boolean containsValue(Object value);

    /**
     * 所有 x
     *
     * @return 所有存在数据的 X 轴键
     */
    Set keys();

    /**
     * 所有行
     *
     * @return 所有行数据
     */
    Collection> rows();

    /**
     * 所有行
     *
     * @return 所有行数据，X 轴 ——> 行数据
     */
    Set>> rowsEntrySet();

    /**
     * 遍历行列处理每一个值
     *
     * @param consumer 处理器
     */
    void forEach(TableConsumer consumer);

    /**
     * 清空
     */
    void clear();

    /**
     * 行数
     *
     * @return 表格行数
     */
    int sizeOfRows();

    /**
     * 最大列数
     *
     * @return 表格最大列数
     */
    int maxSizeOfColumns();

    /**
     * 最小列数
     *
     * @return 表格最小列数
     */
    int minSizeOfColumns();

    /**
     * 映射对数量
     *
     * @return 表格总映射数
     */
    int size();

    /**
     * 是否为空
     *
     * @return 表格是否为空
     */
    default boolean isEmpty() { return sizeOfRows() == 0 || maxSizeOfColumns() == 0; }

    /**
     * 是否包含
     *
     * @param x X轴
     *
     * @return 是否包含指定行的值
     */
    default boolean contains(X x) { return get(x) != null; }

    /**
     * 是否包含
     *
     * @param x X轴
     * @param y Y轴
     *
     * @return 是否包含指定位置的值
     */
    default boolean contains(X x, Y y) { return get(x, y) != null; }
}