com.iohao.game.common.kit.attr.AttrOption Maven / Gradle / Ivy

Go to download
/*
 * ioGame
 * Copyright (C) 2021 - present  渔民小镇 （[email protected]、[email protected]） . All Rights Reserved.
 * # iohao.com . 渔民小镇
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package com.iohao.game.common.kit.attr;

import java.io.Serializable;
import java.util.Objects;
import java.util.function.Supplier;

/**
 * 动态属性的属性项
 *  *     see {@link AttrOptionDynamic}
 * 
 *
 * @param  t
 * @author 渔民小镇
 * @date 2022-01-31
 */
public final class AttrOption implements Serializable {
    final String name;
    final T defaultValue;
    final Supplier supplier;

    AttrOption(String name, T devault, Supplier supplier) {
        Objects.requireNonNull(name);

        this.name = name;
        this.defaultValue = devault;
        this.supplier = supplier;
    }

    public String name() {
        return this.name;
    }

    public T defaultValue() {
        return this.defaultValue;
    }

    /**
     * 初始化 一个 AttrOption
     *
     * @param name name
     * @param   t
     * @return AttrOption
     */
    public static  AttrOption valueOf(String name) {
        return new AttrOption<>(name, null, null);
    }

    /**
     * 初始化 一个 AttrOption
     *
     * @param name         name
     * @param defaultValue 默认值（单例）
     * @param           t
     * @return AttrOption
     */
    public static  AttrOption valueOf(String name, T defaultValue) {
        return new AttrOption<>(name, defaultValue, null);
    }

    /**
     * 初始化一个 AttrOption
     *
     * @param name     name
     * @param supplier 如果值不存在，则从 supplier 获取
     * @param       t
     * @return AttrOption
     */
    public static  AttrOption valueOf(String name, Supplier supplier) {
        return new AttrOption<>(name, null, supplier);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        AttrOption that = (AttrOption) o;

        return Objects.equals(name, that.name);
    }

    @Override
    public int hashCode() {
        return this.name.hashCode();
    }
}