/**
* Copyright (c) 2014, Cloudera, Inc. All Rights Reserved.
*
* Cloudera, Inc. licenses this file to you under the Apache License,
* Version 2.0 (the "License"). You may not use this file except in
* compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* This software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for
* the specific language governing permissions and limitations under the
* License.
*/
package org.kitesdk.minicluster.cli;
import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.ParameterDescription;
import com.beust.jcommander.Parameters;
import com.google.common.collect.Lists;
import java.util.List;
import org.slf4j.Logger;
@Parameters(commandDescription = "Retrieves details on the functions of other commands")
public class Help implements Command {
@Parameter(description = "<commands>")
List<String> helpCommands = Lists.newArrayList();
private final JCommander jc;
private final Logger console;
public Help(JCommander jc, Logger console) {
this.jc = jc;
this.console = console;
}
@Override
public int run() {
boolean hasRequired = false;
if (helpCommands.isEmpty()) {
console.info(
"\nUsage: {} [options] [command] [command options]",
Main.PROGRAM_NAME);
console.info("\n Options:\n");
for (ParameterDescription param : jc.getParameters()) {
hasRequired = printOption(console, param) || hasRequired;
}
if (hasRequired) {
console.info("\n * = required");
}
console.info("\n Commands:\n");
for (String command : jc.getCommands().keySet()) {
console.info(" {}\n\t{}",
command, jc.getCommandDescription(command));
}
console.info("\n Examples:");
console.info("\n # print information for run\n {} help run",
Main.PROGRAM_NAME);
console.info("\n See '{} help <command>' for more information on a " +
"specific command.", Main.PROGRAM_NAME);
} else {
for (String cmd : helpCommands) {
JCommander commander = jc.getCommands().get(cmd);
if (commander == null) {
console.error("Unknown command: {}", cmd);
return 1;
}
console.info("\nUsage: {} [general options] {} {} [command options]",
new Object[] {
Main.PROGRAM_NAME, cmd,
commander.getMainParameterDescription()});
console.info("\n Description:");
console.info("\n {}", jc.getCommandDescription(cmd));
if (!commander.getParameters().isEmpty()) {
console.info("\n Command options:\n");
for (ParameterDescription param : commander.getParameters()) {
hasRequired = printOption(console, param) || hasRequired;
}
if (hasRequired) {
console.info("\n * = required");
}
}
List<String> examples = ((Command) commander.getObjects().get(0)).getExamples();
if (examples != null) {
console.info("\n Examples:");
for (String example : examples) {
if (example.startsWith("#")) {
// comment
console.info("\n {}", example);
} else {
console.info(" {} {} {}",
new Object[] {Main.PROGRAM_NAME, cmd, example});
}
}
}
// add an extra newline in case there are more commands
console.info("");
}
}
return 0;
}
private boolean printOption(Logger console, ParameterDescription param) {
boolean required = param.getParameter().required();
if (!param.getParameter().hidden()) {
console.info(" {} {}\n\t{}{}", new Object[]{
required ? "*" : " ",
param.getNames().trim(),
param.getDescription(),
formatDefault(param)});
}
return required;
}
private String formatDefault(ParameterDescription param) {
Object defaultValue = param.getDefault();
if (defaultValue == null || param.getParameter().arity() < 1) {
return "";
}
return " (default: " + ((defaultValue instanceof String) ?
"\"" + defaultValue + "\"" :
defaultValue.toString()) + ")";
}
@Override
public List<String> getExamples() {
return null;
}
}