GroovyScriptCommand (Grails 4.1.0.M1)

org.grails.cli.profile.commands.script.GroovyScriptCommand

All Implemented Interfaces and Traits:

CommandEvents, ConsoleLogger, FileSystemInteraction, ModelBuilder, ProfileCommand, ProfileRepositoryAware, ServerInteraction, TemplateRenderer
```
@groovy.transform.CompileStaticCompileStatic
abstract class GroovyScriptCommand
extends Script
```
A base class for Groovy scripts that implement commands
Authors:
Graeme Rocher
Since:
3.0

Properties Summary

Properties
Type	Name and description
`private AntBuilder`	`ant` Access to Ant via AntBuilder
`private ConsoleLogger`	`consoleLogger`
`private CommandDescription`	`description`
`private ExecutionContext`	`executionContext`
`ExecutionContext`	`executionContext`
`private FileSystemInteraction`	`fileSystemInteraction`
`private GradleInvoker`	`gradle` Allows invoking of Gradle commands
`private java.lang.String`	`grailsVersion` The version of Grails being used
`private java.lang.String`	`name`
`private Profile`	`profile`
`private ProfileRepository`	`profileRepository`
`private SpringInvoker`	`spring` Allows invoking of Spring Boot's CLI
`private TemplateRenderer`	`templateRenderer`
`private java.lang.String`	`userHome` The location of the user.home directory

Constructor Summary

Constructors
Constructor and description
`GroovyScriptCommand ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`description(java.lang.String desc, java.lang.String usage)` Provides a description for the command Parameters: `desc` - The description `usage` - The usage information
	`void`	`description(java.lang.String desc, Closure detail)` Provides a description for the command Parameters: `desc` - The description `usage` - The usage information
	`java.lang.Object`	`flag(java.lang.String name)` Obtains details of the given flag if it has been set by the user Parameters: `name` - The name of the flag Returns: The flag information, or null if it isn't set by the user
	`java.util.List`	`getArgs()` Returns: The arguments as a list of strings
	`Map`	`getArgsMap()` Returns: The undeclared command line arguments
	`ExecutionContext`	`getExecutionContext()`
	`GrailsConsole`	`getGrailsConsole()` Returns: The GrailsConsole instance
	`java.lang.String`	`getGrailsEnv()` Returns: The name of the current Grails environment
	`boolean`	`handle(ExecutionContext executionContext)` Implementation of the handle method that runs the script Parameters: `executionContext` - The ExecutionContext Returns: True if the script succeeds, false otherwise
	`java.lang.Object`	`methodMissing(java.lang.String name, java.lang.Object args)` Method missing handler used to invoke other commands from a command script Parameters: `name` - The name of the command as a method name (for example 'run-app' would be runApp()) `args` - The arguments to the command
	`void`	`setExecutionContext(ExecutionContext executionContext)`

- Property Detail
  - private AntBuilder ant
    
    Access to Ant via AntBuilder
  - private ConsoleLogger consoleLogger
  - private CommandDescription description
  - private ExecutionContext executionContext
  - ExecutionContext executionContext
  - private FileSystemInteraction fileSystemInteraction
  - private GradleInvoker gradle
    
    Allows invoking of Gradle commands
  - private java.lang.String grailsVersion
    
    The version of Grails being used
  - private java.lang.String name
  - private Profile profile
  - private ProfileRepository profileRepository
  - private SpringInvoker spring
    
    Allows invoking of Spring Boot's CLI
  - private TemplateRenderer templateRenderer
  - private java.lang.String userHome
    
    The location of the user.home directory
- Constructor Detail
  - GroovyScriptCommand()
- Method Detail
  - void description(java.lang.String desc, java.lang.String usage)
    
    Provides a description for the command
    Parameters:
    desc - The description
    usage - The usage information
  - void description(java.lang.String desc, Closure detail)
    
    Provides a description for the command
    Parameters:
    desc - The description
    usage - The usage information
  - java.lang.Object flag(java.lang.String name)
    
    Obtains details of the given flag if it has been set by the user
    Parameters:
    name - The name of the flag
    Returns:
    The flag information, or null if it isn't set by the user
  - java.util.List getArgs()
    
    Returns:
    The arguments as a list of strings
  - Map getArgsMap()
    
    Returns:
    The undeclared command line arguments
  - ExecutionContext getExecutionContext()
  - GrailsConsole getGrailsConsole()
    
    Returns:
    The GrailsConsole instance
  - java.lang.String getGrailsEnv()
    
    Returns:
    The name of the current Grails environment
  - @java.lang.OverrideOverride boolean handle(ExecutionContext executionContext)
    
    Implementation of the handle method that runs the script
    Parameters:
    executionContext - The ExecutionContext
    Returns:
    True if the script succeeds, false otherwise
  - java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)
    
    Method missing handler used to invoke other commands from a command script
    Parameters:
    name - The name of the command as a method name (for example 'run-app' would be runApp())
    args - The arguments to the command
  - void setExecutionContext(ExecutionContext executionContext)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class GroovyScriptCommand

Properties Summary

Constructor Summary

Methods Summary

Property Detail

private AntBuilder ant

private ConsoleLogger consoleLogger

private CommandDescription description

private ExecutionContext executionContext

ExecutionContext executionContext

private FileSystemInteraction fileSystemInteraction

private GradleInvoker gradle

private java.lang.String grailsVersion

private java.lang.String name

private Profile profile

private ProfileRepository profileRepository

private SpringInvoker spring

private TemplateRenderer templateRenderer

private java.lang.String userHome

Constructor Detail

GroovyScriptCommand()

Method Detail

void description(java.lang.String desc, java.lang.String usage)

void description(java.lang.String desc, Closure detail)

java.lang.Object flag(java.lang.String name)

java.util.List getArgs()

Map getArgsMap()

ExecutionContext getExecutionContext()

GrailsConsole getGrailsConsole()

java.lang.String getGrailsEnv()

@java.lang.OverrideOverride boolean handle(ExecutionContext executionContext)

java.lang.Object methodMissing(java.lang.String name, java.lang.Object args)

void setExecutionContext(ExecutionContext executionContext)