Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Don't display hint command in options help

Browse Source 
Fixes gh-471
This commit is contained in:
Phillip Webb
2014-03-18 15:47:35 -07:00
parent 2929d33e37
commit 98e4008b16
2 changed files with 24 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-boot-cli/src/main/java/org/springframework/boot/cli/SpringCli.java
View File

@@ -44,6 +44,7 @@ public class SpringCli {
runner.addCommand(new ShellCommand());
runner.addCommand(new HintCommand(runner));
runner.setOptionCommands(HelpCommand.class, VersionCommand.class);
runner.setHiddenCommands(HintCommand.class);
int exitCode = runner.runAndHandleErrors(args);
if (exitCode != 0) {

26
spring-boot-cli/src/main/java/org/springframework/boot/cli/command/CommandRunner.java
View File

@@ -46,6 +46,8 @@ public class CommandRunner implements Iterable<Command> {
private Class<?>[] optionCommandClasses = {};
private Class<?>[] hiddenCommandClasses = {};
/**
* Create a new {@link CommandRunner} instance.
* @param name the name of the runner or {@code null}
@@ -94,6 +96,16 @@ public class CommandRunner implements Iterable<Command> {
this.optionCommandClasses = commandClasses;
}
/**
* Set the command classes which should be hidden (i.e. executed but not displayed in
* the available commands list).
* @param commandClasses the classes of hidden commands
*/
public void setHiddenCommands(Class<?>... commandClasses) {
Assert.notNull(commandClasses, "CommandClasses must not be null");
this.hiddenCommandClasses = commandClasses;
}
/**
* Returns if the specified command is an option command.
* @param command the command to test
@@ -101,8 +113,16 @@ public class CommandRunner implements Iterable<Command> {
* @see #setOptionCommands(Class...)
*/
public boolean isOptionCommand(Command command) {
for (Class<?> optionCommandClass : this.optionCommandClasses) {
if (optionCommandClass.isInstance(command)) {
return isCommandInstanceOf(command, this.optionCommandClasses);
}
private boolean isHiddenCommand(Command command) {
return isCommandInstanceOf(command, this.hiddenCommandClasses);
}
private boolean isCommandInstanceOf(Command command, Class<?>[] commandClasses) {
for (Class<?> commandClass : commandClasses) {
if (commandClass.isInstance(command)) {
return true;
}
}
@@ -249,7 +269,7 @@ public class CommandRunner implements Iterable<Command> {
Log.info("");
Log.info("Available commands are:");
for (Command command : this.commands) {
if (!isOptionCommand(command)) {
if (!isOptionCommand(command) && !isHiddenCommand(command)) {
String usageHelp = command.getUsageHelp();
String description = command.getDescription();
Log.info(String.format("\n %1$s %2$-15s\n %3$s", command.getName(),