@groovy.transform.CompileStatic final enum Environment extends java.lang.Enum<E<E>>
Represents the current environment.
Modifiers | Name | Description |
---|---|---|
static Environment |
APPLICATION |
For the application data source, primarily for backward compatibility for those applications that use ApplicationDataSource.groovy. |
static Environment |
CUSTOM |
A custom environment |
static java.lang.String |
DEFAULT |
Constants that indicates whether this GrailsApplication is running in the default environment |
static Environment |
DEVELOPMENT |
The development environment |
static java.lang.String |
ENV_GRAILS_HOME |
The name of the GRAILS_HOME environment variable |
static java.lang.String |
ENV_KEY |
Constant used to resolve the environment via System.getenv(Environment.ENV_KEY). |
static java.lang.String |
FULL_STACKTRACE |
Whether the display of full stack traces is needed |
static java.lang.String |
INITIALIZING |
Whether Grails is in the middle of bootstrapping or not |
static java.lang.String |
INTERACTIVE_MODE_ENABLED |
Whether interactive mode is enabled |
static java.lang.String |
KEY |
Constant used to resolve the environment via System.getProperty(Environment.KEY) |
static Environment |
MAX_VALUE |
|
static Environment |
MIN_VALUE |
|
static Environment |
PRODUCTION |
The production environment |
static java.lang.String |
RELOAD_ENABLED |
Specify whether reloading is enabled for this environment |
static java.lang.String |
RELOAD_LOCATION |
The location where to reload resources from |
static java.lang.String |
RUN_ACTIVE |
Constant indicating whether run-app or test-app was executed |
static java.lang.String |
STANDALONE |
Whether Grails has been executed standalone via the static void main method and not loaded in via the container |
static Environment |
TEST |
The test environment |
static org.codehaus.groovy.control.MultipleCompilationErrorsException |
currentCompilationError |
|
static java.lang.Throwable |
currentReloadError |
Type | Name and description |
---|---|
java.lang.Throwable |
currentReloadError |
boolean |
initializing |
java.lang.String |
name |
Type Params | Return Type | Name and description |
---|---|---|
|
static java.lang.Object |
executeForCurrentEnvironment(groovy.lang.Closure<?> closure) Takes an environment specific DSL block like: |
|
static java.lang.Object |
executeForEnvironment(Environment env, groovy.lang.Closure<?> closure) Takes an environment specific DSL block like: |
|
static Environment |
getCurrent() Returns the current environment which is typcally either DEVELOPMENT, PRODUCTION or TEST. |
|
static org.codehaus.groovy.control.MultipleCompilationErrorsException |
getCurrentCompilationError() |
|
static Environment |
getCurrentEnvironment()
|
|
static java.lang.Throwable |
getCurrentReloadError() |
|
static Environment |
getEnvironment(java.lang.String shortName) Returns the environment for the given short name |
|
static groovy.lang.Closure<?> |
getEnvironmentSpecificBlock(groovy.lang.Closure<?> closure) Takes an environment specific DSL block like: |
|
static groovy.lang.Closure<?> |
getEnvironmentSpecificBlock(Environment env, groovy.lang.Closure<?> closure) Takes an environment specific DSL block like: |
|
static java.lang.String |
getGrailsVersion()
|
|
java.lang.String |
getName()
|
|
java.lang.String |
getReloadLocation()
|
|
boolean |
hasReloadLocation()
|
|
static boolean |
isDevelopmentEnvironmentAvailable() This method will return true if the 'grails-app' directory was found, regardless of whether reloading is active or not |
|
static boolean |
isDevelopmentMode() Returns true if the application is running in development mode (within grails run-app) |
|
static boolean |
isDevelopmentRun() This method will return true the application is run |
|
static boolean |
isDevtoolsRestart() Checks if the run of the app is due to spring dev-tools or not. |
|
static boolean |
isFork() Whether this is a fork of the Grails command line environment |
|
static boolean |
isInitializing()
|
|
static boolean |
isInteractiveMode()
|
|
boolean |
isReloadEnabled()
|
|
static boolean |
isReloadInProgress() |
|
static boolean |
isReloadingAgentEnabled()
|
|
static boolean |
isStandalone() Whether the application has been executed standalone via static void main. |
|
static boolean |
isStandaloneDeployed() Whether the application is running standalone within a JAR |
|
static boolean |
isSystemSet()
|
|
static boolean |
isWarDeployed() Check whether the application is deployed |
|
static boolean |
isWithinShell() Returns whether the environment is running within the Grails shell (executed via the 'grails' command line in a terminal window) |
|
Environment |
next() |
|
Environment |
previous() |
|
static void |
reset() Reset the current environment |
|
static void |
setCurrentReloadError(java.lang.Throwable currentReloadError) |
|
static void |
setInitializing(boolean initializing) |
|
void |
setName(java.lang.String name) Set the name. |
|
static Environment |
valueOf(java.lang.String name) |
|
static final Environment[] |
values() |
For the application data source, primarily for backward compatibility for those applications that use ApplicationDataSource.groovy.
A custom environment
Constants that indicates whether this GrailsApplication is running in the default environment
The development environment
The name of the GRAILS_HOME environment variable
Constant used to resolve the environment via System.getenv(Environment.ENV_KEY).
Whether the display of full stack traces is needed
Whether Grails is in the middle of bootstrapping or not
Whether interactive mode is enabled
Constant used to resolve the environment via System.getProperty(Environment.KEY)
The production environment
Specify whether reloading is enabled for this environment
The location where to reload resources from
Constant indicating whether run-app or test-app was executed
Whether Grails has been executed standalone via the static void main method and not loaded in via the container
The test environment
Takes an environment specific DSL block like:
environments {
development {}
production {}
}
And executes the closure that relates to the current environment
closure
- The top level closure Takes an environment specific DSL block like:
environments {
development {}
production {}
}
And executes the closure that relates to the specified environment
env
- The environment to useclosure
- The top level closureReturns the current environment which is typcally either DEVELOPMENT, PRODUCTION or TEST. For custom environments CUSTOM type is returned.
Returns the environment for the given short name
shortName
- The short name Takes an environment specific DSL block like:
environments {
development {}
production {}
}
And returns the closure that relates to the current environment
closure
- The top level closure Takes an environment specific DSL block like:
environments {
development {}
production {}
}
And returns the closure that relates to the specified
env
- The environment to useclosure
- The top level closure
This method will return true if the 'grails-app' directory was found, regardless of whether reloading is active or not
Returns true if the application is running in development mode (within grails run-app)
This method will return true the application is run
Checks if the run of the app is due to spring dev-tools or not.
Whether this is a fork of the Grails command line environment
Whether the application has been executed standalone via static void main. This method will return true when the application is executed via `java -jar` or if the application is run directly via the main method within an IDE
Whether the application is running standalone within a JAR This method will return true only if the the application is executed via `java -jar` and not if it is run via the main method within an IDE
Check whether the application is deployed
Returns whether the environment is running within the Grails shell (executed via the 'grails' command line in a terminal window)
Reset the current environment
Set the name.
name
- the name