sirius.kernel.health.console

Class DocCommand

java.lang.Object

sirius.kernel.health.console.DocCommand

All Implemented Interfaces:

Named, Command

public class DocCommand
extends Object
implements Command

Provides a simple API documentation by accepting a class name as parameter and listing all methods as result.

This command will try to find a class matching the given name and output all methods accessible methods along with their signature.

Nested Class Summary

Nested classes/interfaces inherited from interface sirius.kernel.health.console.Command

Command.Output

Constructor Summary

Constructors

Constructor and Description
DocCommand()

Method Summary

Modifier and Type	Method and Description
void	execute(Command.Output output, String... params) Executes the given command with the given parameters.
String	getDescription() Returns a short description of the command.
String	getName() Returns the name of the part.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocCommand

public DocCommand()

Method Detail

execute

public void execute(Command.Output output,
                    String... params)
             throws Exception

Description copied from interface: Command

Executes the given command with the given parameters.

Specified by:

execute in interface Command

Parameters:

output - provides access to the output interface used to generate output

params - provides the parameters entered in the console

Throws:

Exception - in case of an error. Throw a HandledException to signal, that all logging and handling has already been performed. Any other exception will be logged and reported as system error.

getName

@Nonnull
public String getName()

Description copied from interface: Named

Returns the name of the part.

The return value is used as part name when the Register annotation is processed.

Specified by:

getName in interface Named

Returns:

the name of this part

getDescription

public String getDescription()

Description copied from interface: Command

Returns a short description of the command.

Specified by:

getDescription in interface Command

Returns:

the description of the command