Package org.springframework.boot.cli.command.core

Class HintCommand

java.lang.Object

org.springframework.boot.cli.command.AbstractCommand

org.springframework.boot.cli.command.core.HintCommand

All Implemented Interfaces:

Command

public class HintCommand
extends AbstractCommand

Internal Command to provide hints for shell auto-completion. Expects to be called with the current index followed by a list of arguments already typed.

Since:

1.0.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor	Description
HintCommand(CommandRunner commandRunner)

Method Summary

Modifier and Type	Method	Description
ExitStatus	run(String... args)	Run the command.

Methods inherited from class org.springframework.boot.cli.command.AbstractCommand

getDescription, getExamples, getHelp, getName, getOptionsHelp, getUsageHelp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HintCommand

public HintCommand(CommandRunner commandRunner)

Method Details

run

public ExitStatus run(String... args)
               throws Exception

Description copied from interface: Command

Run the command.

Parameters:

args - command arguments (this will not include the command itself)

Returns:

the outcome of the command

Throws:

Exception - if the command fails