001/*
002 * Copyright (c) 2016-2017 Daniel Ennis (Aikar) - MIT License
003 *
004 *  Permission is hereby granted, free of charge, to any person obtaining
005 *  a copy of this software and associated documentation files (the
006 *  "Software"), to deal in the Software without restriction, including
007 *  without limitation the rights to use, copy, modify, merge, publish,
008 *  distribute, sublicense, and/or sell copies of the Software, and to
009 *  permit persons to whom the Software is furnished to do so, subject to
010 *  the following conditions:
011 *
012 *  The above copyright notice and this permission notice shall be
013 *  included in all copies or substantial portions of the Software.
014 *
015 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
016 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
017 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
018 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
019 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
020 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
021 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
022 */
023
024package co.aikar.commands;
025
026public class HelpEntry {
027
028    private final CommandHelp commandHelp;
029    private final RegisteredCommand command;
030    private int searchScore = 1;
031
032    HelpEntry(CommandHelp commandHelp, RegisteredCommand command) {
033        this.commandHelp = commandHelp;
034        this.command = command;
035    }
036
037    RegisteredCommand getRegisteredCommand() {
038        return this.command;
039    }
040
041    public String getCommand() {
042        return this.command.command;
043    }
044
045    public String getCommandPrefix() {
046        return this.commandHelp.getCommandPrefix();
047    }
048
049    public String getParameterSyntax() {
050        return this.getParameterSyntax(null);
051    }
052
053    public String getParameterSyntax(CommandIssuer issuer) {
054        String translated = this.command.getSyntaxText(issuer);
055        return translated != null ? translated : "";
056    }
057
058    public String getDescription(){
059        return this.command.getHelpText();
060    }
061
062    public void setSearchScore(int searchScore) {
063        this.searchScore = searchScore;
064    }
065
066    public boolean shouldShow() {
067        return this.searchScore > 0;
068    }
069
070    public int getSearchScore() {
071        return searchScore;
072    }
073
074    public String getSearchTags() {
075        return command.helpSearchTags;
076    }
077
078    public CommandParameter[] getParameters() {
079        return command.parameters;
080    }
081}