org.jline.console.CmdDesc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jline-console Show documentation
JLine
The newest version!
/*
 * Copyright (c) 2002-2020, the original author(s).
 *
 * This software is distributable under the BSD license. See the terms of the
 * BSD license in the documentation provided with this software.
 *
 * https://opensource.org/licenses/BSD-3-Clause
 */
package org.jline.console;

import java.util.*;
import java.util.regex.Pattern;

import org.jline.utils.AttributedString;

public class CmdDesc {
    private List mainDesc;
    private List argsDesc;
    private TreeMap> optsDesc;
    private Pattern errorPattern;
    private int errorIndex = -1;
    private boolean valid = true;
    private boolean command = false;
    private boolean subcommand = false;
    private boolean highlighted = true;

    public CmdDesc() {
        command = false;
    }

    public CmdDesc(boolean valid) {
        this.valid = valid;
    }

    public CmdDesc(List argsDesc) {
        this(new ArrayList<>(), argsDesc, new HashMap<>());
    }

    public CmdDesc(List argsDesc, Map> optsDesc) {
        this(new ArrayList<>(), argsDesc, optsDesc);
    }

    public CmdDesc(
            List mainDesc, List argsDesc, Map> optsDesc) {
        this.argsDesc = new ArrayList<>(argsDesc);
        this.optsDesc = new TreeMap<>(optsDesc);
        if (mainDesc.isEmpty() && optsDesc.containsKey("main")) {
            this.mainDesc = new ArrayList<>(optsDesc.get("main"));
            this.optsDesc.remove("main");
        } else {
            this.mainDesc = new ArrayList<>(mainDesc);
        }
        this.command = true;
    }

    public boolean isValid() {
        return valid;
    }

    public boolean isCommand() {
        return command;
    }

    public void setSubcommand(boolean subcommand) {
        this.subcommand = subcommand;
    }

    public boolean isSubcommand() {
        return subcommand;
    }

    public void setHighlighted(boolean highlighted) {
        this.highlighted = highlighted;
    }

    public boolean isHighlighted() {
        return highlighted;
    }

    public CmdDesc mainDesc(List mainDesc) {
        this.mainDesc = new ArrayList<>(mainDesc);
        return this;
    }

    public void setMainDesc(List mainDesc) {
        this.mainDesc = new ArrayList<>(mainDesc);
    }

    public List getMainDesc() {
        return mainDesc;
    }

    public TreeMap> getOptsDesc() {
        return optsDesc;
    }

    public void setErrorPattern(Pattern errorPattern) {
        this.errorPattern = errorPattern;
    }

    public Pattern getErrorPattern() {
        return errorPattern;
    }

    public void setErrorIndex(int errorIndex) {
        this.errorIndex = errorIndex;
    }

    public int getErrorIndex() {
        return errorIndex;
    }

    public List getArgsDesc() {
        return argsDesc;
    }

    public boolean optionWithValue(String option) {
        for (String key : optsDesc.keySet()) {
            if (key.matches("(^|.*\\s)" + option + "($|=.*|\\s.*)")) {
                return key.contains("=");
            }
        }
        return false;
    }

    public AttributedString optionDescription(String key) {
        return optsDesc.get(key).size() > 0 ? optsDesc.get(key).get(0) : new AttributedString("");
    }
}