ApplicationCommand (Grails 7.0.5-SNAPSHOT)

Summary:
Property
Method

| Detail:
Property
Method

grails.dev.commands.ApplicationCommand

All Implemented Interfaces and Traits:

Described, Named
```
@groovy.transform.Trait
@groovy.transform.CompileStatic
trait ApplicationCommand
extends java.lang.Object
implements Described, Named
```
Represents a command that runs with access to the org.springframework.context.ApplicationContext.
Authors:
Graeme Rocher
Since:
3.0

Properties Summary

Properties
Type	Name and description
`ConfigurableApplicationContext`	`applicationContext`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getDescription()` The description of the command.
	`java.lang.String`	`getName()` Calculates the command name as used on the command line.
	`abstract boolean`	`handle(ExecutionContext executionContext)` Executes the command.

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)`

- Property Detail
  - ConfigurableApplicationContext applicationContext
- Method Detail
  - @java.lang.Override
    java.lang.String getDescription()
    
    The description of the command. By default this returns the name of the command.
    Returns:
    The description of the command
  - @java.lang.Override
    java.lang.String getName()
    
    Calculates the command name as used on the command line.
    Example: UrlMappingsReportCommand -> url-mappings-report
    Returns:
    The command line name of the command
  - abstract boolean handle(ExecutionContext executionContext)
    
    Executes the command.
    Parameters:
    executionContext - The execution context
    Returns:
    true if the command was successful; false otherwise

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation