Mercurial > hg > release > thermostat-2.0
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/PluginConfiguration.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.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Objects; import java.util.Set; import org.apache.commons.cli.Options; import com.redhat.thermostat.launcher.BundleInformation; public class PluginConfiguration { private final List<NewCommand> newCommands; private final List<CommandGroupMetadata> commandGroupMetadataList; private final List<CommandExtensions> extensions; private final PluginID pluginID; private final Configurations configurations; public PluginConfiguration(List<NewCommand> newCommands, List<CommandGroupMetadata> commandGroupMetadataList, List<CommandExtensions> extensions, PluginID pluginID, Configurations config) { this.newCommands = newCommands; this.commandGroupMetadataList = commandGroupMetadataList; this.extensions = extensions; this.pluginID = pluginID; this.configurations = config; } public List<CommandExtensions> getExtendedCommands() { return extensions; } public List<NewCommand> getNewCommands() { return newCommands; } public List<CommandGroupMetadata> getCommandGroupMetadata() { return commandGroupMetadataList; } public PluginID getPluginID() { return this.pluginID; } public Configurations getConfigurations() { return this.configurations; } public boolean hasValidID() { return this.pluginID.isValidID(); } public boolean hasConfigurations() { return !this.configurations.isEmpty(); } public static class CommandExtensions { private final String commandName; private final List<BundleInformation> toLoad; public CommandExtensions(String name, List<BundleInformation> toLoad) { this.commandName = name; this.toLoad = toLoad; } public String getCommandName() { return commandName; } public List<BundleInformation> getBundles() { return toLoad; } @Override public String toString() { return "extends " + commandName + " using " + toLoad.toString(); } } public static class NewCommand { private final String commandName; private final String summary; private final String description; private final List<String> commandGroups; private final String usage; private final List<String> positionalArguments; private final Options options; private final List<Subcommand> subcommands; private final Set<Environment> environment; private final List<BundleInformation> bundles; public NewCommand(String name, String summary, String description, List<String> commandGroups, String usage, List<String> positionalArguments, Options options, List<Subcommand> subcommands, Set<Environment> environment, List<BundleInformation> bundles) { this.commandName = name; this.summary = summary; this.description = description; this.commandGroups = commandGroups; this.usage = usage; this.positionalArguments = positionalArguments; this.options = options; this.subcommands = subcommands; this.environment = environment; this.bundles = bundles; } public String getCommandName() { return commandName; } public String getSummary() { return summary; } public String getDescription() { return description; } public List<String> getCommandGroups() { return commandGroups; } /** * The usage string may be null if no usage string was explicitly * provided. In that case, usage should be "computed" using options and * arguments */ public String getUsage() { return usage; } /** Returns a list of strings indicating positional arguments */ public List<String> getPositionalArguments() { return positionalArguments; } /** Returns options (both optional and required) */ public Options getOptions() { return options; } public List<Subcommand> getSubcommands() { return subcommands; } /** Returns the environments where this command is available to be used */ public Set<Environment> getEnvironments() { return Collections.unmodifiableSet(environment); } public List<BundleInformation> getBundles() { return Collections.unmodifiableList(bundles); } } public static class CommandGroupMetadata { private final String name; private final String description; private final int sortOrder; public CommandGroupMetadata(String name, String description, int sortOrder) { this.name = name; this.description = description; this.sortOrder = sortOrder; } public String getName() { return name; } public String getDescription() { return description; } public int getSortOrder() { return sortOrder; } @Override public boolean equals(Object o) { if (!(o instanceof CommandGroupMetadata)) { return false; } if (this == o) { return true; } CommandGroupMetadata other = (CommandGroupMetadata) o; return Objects.equals(this.getName(), other.getName()); } @Override public int hashCode() { return Objects.hash(name); } } public static class PluginID { private final String pluginID; public PluginID(String pluginID) { this.pluginID = pluginID; } public String getPluginID() { return this.pluginID; } public boolean isValidID() { return !this.pluginID.equals(""); } @Override public boolean equals(Object obj) { if (!(obj instanceof PluginID)) { return false; } if (obj == this) { return true; } PluginID testObj = (PluginID) obj; if (this.pluginID.equals(testObj.getPluginID())) { return true; } return false; } @Override public int hashCode() { return this.pluginID.hashCode(); } } public static class Configurations { private Map<String, String> fileNames = new HashMap<String, String>(); public Configurations(Map<String, String> fileNames) { this.fileNames = fileNames; } public static Configurations emptyConfigurations() { return new Configurations(Collections.<String, String>emptyMap()); } public boolean containsFile(String fileName) { return fileNames.containsKey(fileName); } public boolean isEmpty() { return fileNames.isEmpty(); } public String getFullFilePath(String fileName) { return fileNames.get(fileName); } } public static class Subcommand { private final String name; private final String description; private final Options options; public Subcommand(String name, String description, Options options) { this.name = name; this.description = description; this.options = options; } public String getName() { return name; } public String getDescription() { return description; } public Options getOptions() { return options; } } }