cn.nukkit.command.tree.node.IParamNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powernukkitx Show documentation
Make Nukkit great again!
There is a newer version: 1.20.40-r1
package cn.nukkit.command.tree.node;

import cn.nukkit.api.PowerNukkitXOnly;
import cn.nukkit.api.Since;
import cn.nukkit.command.data.CommandEnum;
import cn.nukkit.command.data.CommandParamType;
import cn.nukkit.command.tree.ParamList;
import cn.nukkit.lang.CommandOutputContainer;
import cn.nukkit.network.protocol.types.CommandOutputMessage;
import cn.nukkit.utils.OK;

/**
 * 代表一个抽象的命令节点，类型T对应节点解析结果类型

 */
@PowerNukkitXOnly
@Since("1.19.60-r1")
public interface IParamNode {

    /**
     * 负责填充该参数节点,覆写该方法需要实现对接受参数arg的验证以及解析成为对应类型T的结果
     * 

     * 当验证失败或者解析失败,请调用{@link #error(String)}方法标记错误.形如{@code this.error()}
     *
     * @param arg the arg
     */
    void fill(String arg);

    /**
     * 获取已被{@link #fill(String)}填充后的节点值,会自动转型为接受类型E,不会判断是否能成功转型
有可能抛出{@link ClassCastException}
     */
     E get();

    /**
     * 将节点重置回初始化状态,以待下次填充{@link #fill(String)}
     */
    void reset();

    /**
     * 该节点是否已经得到结果

     * 该方法返回值为false时,将会一直重复对该节点执行填充{@link #fill(String)}直到该方法返回true或者命令输入参数用完
     */
    boolean hasResult();

    /**
     * 该命令节点是否为可选值,可选值不一定需要被填充{@link #fill(String)}
     */
    boolean isOptional();

    /**
     * 获取该节点所属{@link ParamList}
     *
     * @return the parent
     */
    ParamList getParent();

    /**
     * 标记该节点的{@link #fill(String)}出现错误，输出默认错误信息
     */
    default void error() {
        this.getParent().error();
    }

    /**
     * 标记该节点的{@link #fill(String)}出现错误
     *
     * @param key 添加的错误信息
     */
    default void error(String key) {
        this.error(key, CommandOutputContainer.EMPTY_STRING);
    }

    /**
     * 标记该节点的{@link #fill(String)}出现错误
     *
     * @param key    添加的错误信息，可以填写多语言文本key
     * @param params 填充多语言文本的参数
     */
    default void error(String key, String... params) {
        var list = this.getParent();
        list.error();
        list.addMessage(key, params);
    }

    /**
     * 标记该节点的{@link #fill(String)}出现错误
     *
     * @param messages 添加的错误信息{@link CommandOutputMessage}
     */
    default void error(CommandOutputMessage... messages) {
        var list = this.getParent();
        list.error();
        list.addMessage(messages);
    }

    /**
     * 这个方法用于初始化{@link ParamList}和一些能从{@link cn.nukkit.command.data.CommandParameter CommandParameter}得到的参数,例如optional enumData等，插件不需要调用
     *
     * @param parent   the parent
     * @param name     the name
     * @param optional the optional
     * @param type     the type
     * @param enumData the enum data
     * @param postFix  the post fix
     * @return the param node
     */
    default IParamNode init(ParamList parent, String name, boolean optional, CommandParamType type, CommandEnum enumData, String postFix) {
        return this;
    }
}