Mercurial > hg > thermostat
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/CommandInfo.java @ 2593:767b2627c92d
Implement cli/shell command-group support
Reviewed-by: jerboaa
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-November/021748.html
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-December/021824.html
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-January/021934.html
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-February/022139.html
author | Andrew Azores <aazores@redhat.com> |
---|---|
date | Tue, 14 Feb 2017 11:26:33 -0500 |
parents | e7fd8adb5f9c |
children |
line wrap: on
line source
/* * Copyright 2012-2017 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat 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 * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.launcher.internal; import java.util.List; import java.util.Set; import com.redhat.thermostat.launcher.internal.PluginConfiguration.CommandGroupMetadata; import org.apache.commons.cli.Options; import com.redhat.thermostat.launcher.BundleInformation; public interface CommandInfo { /** * Returns a name for this command. This will be used by the user to select * this command. */ public String getName(); /** * A very short description of the command indicating what it does. Ideally * a small sentence. */ public String getSummary(); /** * A description of the command indicating what it does. Unlike * {@link #getSummary()}, this can be as detailed as needed. */ public String getDescription(); /** * A simple one-word tag used to group related commands together, * such as "vm", "agent", "thread", or "numa". Useful for scenarios * where subcommands are not applicable. Commands within a group are * placed together in help output and receive a "see also" mention * in help output for other commands within their group. */ public List<String> getCommandGroups(); /** * How the user should invoke this command */ public String getUsage(); /** * Returns the Options that the command is prepared to handle. * If the user provides unknown or malformed arguments, this command will * not be invoked. */ public Options getOptions(); /** * A list of subcommands which this command accepts. */ public List<PluginConfiguration.Subcommand> getSubcommands(); /** * Environments where this command is available */ public Set<Environment> getEnvironments(); List<BundleInformation> getBundles(); }