CommandRunner (Grails 7.0.1)

org.grails.cli.command.CommandRunner

All Implemented Interfaces and Traits:

java.lang.Iterable
```
public class CommandRunner
extends java.lang.Object
implements java.lang.Iterable
```
Main class used to run org.springframework.boot.cli.command.Commands.
Authors:
Phillip Webb
Since:
1.0.0
See Also:
addCommand(org.springframework.boot.cli.command.Command)
CommandRunner.runAndHandleErrors

Constructor Summary

Constructors
Constructor and description
`CommandRunner(java.lang.String name)` Create a new CommandRunner instance.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addCommand(Command command)` Add the specified command.
	`public void`	`addCommands(java.lang.Iterable<org.springframework.boot.cli.command.Command> commands)` Add the specified commands.
	`protected void`	`afterRun(Command command)` Subclass hook called after a command has run.
	`protected void`	`beforeRun(Command command)` Subclass hook called before a command is run.
	`protected boolean`	`errorMessage(java.lang.String message)`
	`public Command`	`findCommand(java.lang.String name)` Find a command by name.
	`protected final java.util.List<org.springframework.boot.cli.command.Command>`	`getCommands()`
	`public java.lang.String`	`getName()` Return the name of the runner or an empty string.
	`public boolean`	`isOptionCommand(Command command)` Returns if the specified command is an option command.
	`public java.util.Iterator<org.springframework.boot.cli.command.Command>`	`iterator()`
	`protected void`	`printStackTrace(java.lang.Exception ex)`
	`protected ExitStatus`	`run(java.lang.String args)` Parse the arguments and run a suitable command.
	`public int`	`runAndHandleErrors(java.lang.String args)` Run the appropriate and handle and errors.
	`public void`	`setHiddenCommands(java.lang.Class<?> commandClasses)` Set the command classes which should be hidden (i.e. executed but not displayed in the available commands list).
	`public void`	`setOptionCommands(java.lang.Class<?> commandClasses)` Set the command classes which should be considered option commands.
	`protected void`	`showUsage()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Constructor Detail
  - public CommandRunner(java.lang.String name)
    
    Create a new CommandRunner instance.
    Parameters:
    name - the name of the runner or null
- Method Detail
  - public void addCommand(Command command)
    
    Add the specified command.
    Parameters:
    command - the command to add.
  - public void addCommands(java.lang.Iterable<org.springframework.boot.cli.command.Command> commands)
    
    Add the specified commands.
    Parameters:
    commands - the commands to add
  - protected void afterRun(Command command)
    
    Subclass hook called after a command has run.
    Parameters:
    command - the command that has run
  - protected void beforeRun(Command command)
    
    Subclass hook called before a command is run.
    Parameters:
    command - the command about to run
  - protected boolean errorMessage(java.lang.String message)
  - public Command findCommand(java.lang.String name)
    
    Find a command by name.
    Parameters:
    name - the name of the command
    Returns:
    the command or null if not found
  - protected final java.util.List<org.springframework.boot.cli.command.Command> getCommands()
  - public java.lang.String getName()
    
    Return the name of the runner or an empty string. Non-empty names will include a trailing space character so that they can be used as a prefix.
    Returns:
    the name of the runner
  - public boolean isOptionCommand(Command command)
    
    Returns if the specified command is an option command.
    Parameters:
    command - the command to test
    Returns:
    true if the command is an option command
    See Also:
    setOptionCommands(Class...)
  - @java.lang.Override
    public java.util.Iterator<org.springframework.boot.cli.command.Command> iterator()
  - protected void printStackTrace(java.lang.Exception ex)
  - protected ExitStatus run(java.lang.String args)
    
    Parse the arguments and run a suitable command.
    throws:
    Exception if the command fails
    
    Parameters:
    args - the arguments
    Returns:
    the outcome of the command
  - public int runAndHandleErrors(java.lang.String args)
    
    Run the appropriate and handle and errors.
    Parameters:
    args - the input arguments
    Returns:
    a return status code (non boot is used to indicate an error)
  - public void setHiddenCommands(java.lang.Class<?> commandClasses)
    
    Set the command classes which should be hidden (i.e. executed but not displayed in the available commands list).
    Parameters:
    commandClasses - the classes of hidden commands
  - public void setOptionCommands(java.lang.Class<?> commandClasses)
    
    Set the command classes which should be considered option commands. An option command is a special type of command that usually makes more sense to present as if it is an option. For example '--version'.
    Parameters:
    commandClasses - the classes of option commands.
    See Also:
    isOptionCommand(org.springframework.boot.cli.command.Command)
  - protected void showUsage()

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class CommandRunner

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public CommandRunner(java.lang.String name)

Method Detail

public void addCommand(Command command)

public void addCommands(java.lang.Iterable<org.springframework.boot.cli.command.Command> commands)

protected void afterRun(Command command)

protected void beforeRun(Command command)

protected boolean errorMessage(java.lang.String message)

public Command findCommand(java.lang.String name)

protected final java.util.List<org.springframework.boot.cli.command.Command> getCommands()

public java.lang.String getName()

public boolean isOptionCommand(Command command)

@java.lang.Override
public java.util.Iterator<org.springframework.boot.cli.command.Command> iterator()

protected void printStackTrace(java.lang.Exception ex)

protected ExitStatus run(java.lang.String args)

public int runAndHandleErrors(java.lang.String args)

public void setHiddenCommands(java.lang.Class<?> commandClasses)

public void setOptionCommands(java.lang.Class<?> commandClasses)

protected void showUsage()

[Java] Class CommandRunner

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public CommandRunner(java.lang.String name)

Method Detail

public void addCommand(Command command)

public void addCommands(java.lang.Iterable<org.springframework.boot.cli.command.Command> commands)

protected void afterRun(Command command)

protected void beforeRun(Command command)

protected boolean errorMessage(java.lang.String message)

public Command findCommand(java.lang.String name)

protected final java.util.List<org.springframework.boot.cli.command.Command> getCommands()

public java.lang.String getName()

public boolean isOptionCommand(Command command)

@java.lang.Overridepublic java.util.Iterator<org.springframework.boot.cli.command.Command> iterator()

protected void printStackTrace(java.lang.Exception ex)

protected ExitStatus run(java.lang.String args)

public int runAndHandleErrors(java.lang.String args)

public void setHiddenCommands(java.lang.Class<?> commandClasses)

public void setOptionCommands(java.lang.Class<?> commandClasses)

protected void showUsage()

@java.lang.Override
public java.util.Iterator<org.springframework.boot.cli.command.Command> iterator()