Environment (Grace Framework

grails.util.Environment

@CompileStatic
@SuppressWarnings(value: FieldName)
enum Environment

Represents the current environment.

Authors:: Graeme Rocher

Since:: 1.1

Enum Constants Summary

Enum constants classes
Enum constant	Description
`APPLICATION`	For the application data source, primarily for backward compatibility for those applications that use ApplicationDataSource.groovy.
`CUSTOM`	A custom environment
`DEVELOPMENT`	The development environment
`PRODUCTION`	The production environment
`TEST`	The test environment

Field Summary

Fields
Modifiers	Name	Description
`static String`	`DEFAULT`	Constants that indicates whether this GrailsApplication is running in the default environment
`static String`	`ENV_GRAILS_HOME`	The name of the GRAILS_HOME environment variable
`static String`	`ENV_KEY`	Constant used to resolve the environment via System.getenv(Environment.ENV_KEY).
`static String`	`FULL_STACKTRACE`	Whether the display of full stack traces is needed
`static String`	`INITIALIZING`	Whether Grails is in the middle of bootstrapping or not
`static String`	`INTERACTIVE_MODE_ENABLED`	Whether interactive mode is enabled
`static String`	`KEY`	Constant used to resolve the environment via System.getProperty(Environment.KEY)
`static Environment`	`MAX_VALUE`
`static Environment`	`MIN_VALUE`
`static String`	`RELOAD_ENABLED`	Specify whether reloading is enabled for this environment
`static String`	`RELOAD_LOCATION`	The location where to reload resources from
`static String`	`RUN_ACTIVE`	Constant indicating whether run-app or test-app was executed
`static String`	`STANDALONE`	Whether Grails has been executed standalone via the static void main method and not loaded in via the container
`static MultipleCompilationErrorsException`	`currentCompilationError`
`static Throwable`	`currentReloadError`

Properties Summary

Properties
Type	Name and description
`Throwable`	`currentReloadError`
`boolean`	`initializing`
`String`	`name`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Object`	`executeForCurrentEnvironment(Closure<?> closure)` Takes an environment specific DSL block like:
	`static Object`	`executeForEnvironment(Environment env, Closure<?> closure)` Takes an environment specific DSL block like:
	`static Environment`	`getCurrent()` Returns the current environment which is typically either DEVELOPMENT, PRODUCTION or TEST.
	`static MultipleCompilationErrorsException`	`getCurrentCompilationError()`
	`static Environment`	`getCurrentEnvironment()` See Also: getCurrent()
	`static Throwable`	`getCurrentReloadError()`
	`static Environment`	`getEnvironment(String shortName)` Returns the environment for the given short name
	`static Closure<?>`	`getEnvironmentSpecificBlock(Closure<?> closure)` Takes an environment specific DSL block like:
	`static Closure<?>`	`getEnvironmentSpecificBlock(Environment env, Closure<?> closure)` Takes an environment specific DSL block like:
	`static String`	`getGrailsVersion()` Returns: The current Grails version
	`String`	`getName()` Returns: the name of the environment
	`String`	`getReloadLocation()` Returns: Obtains the location to reload resources from
	`boolean`	`hasReloadLocation()` Returns: Whether a reload location is specified
	`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`	`isFork()` Whether this is a fork of the Grails command line environment
	`static boolean`	`isInitializing()` Returns: Whether interactive mode is enabled
	`static boolean`	`isInteractiveMode()` Returns: Whether interactive mode is enabled
	`boolean`	`isReloadEnabled()` Returns: Returns whether reload is enabled for the environment
	`static boolean`	`isReloadInProgress()`
	`static boolean`	`isReloadingAgentEnabled()` Returns: true if the reloading agent is active
	`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()` Returns: Return true if the environment has been set as a System property
	`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)
	`static void`	`reset()` Reset the current environment
	`static void`	`setCurrentReloadError(Throwable currentReloadError)`
	`static void`	`setInitializing(boolean initializing)`
	`void`	`setName(String name)` Set the name.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Enum Constant Detail
  - Environment APPLICATION
    
    For the application data source, primarily for backward compatibility for those applications that use ApplicationDataSource.groovy.
  - Environment CUSTOM
    
    A custom environment
  - Environment DEVELOPMENT
    
    The development environment
  - Environment PRODUCTION
    
    The production environment
  - Environment TEST
    
    The test environment
- Field Detail
  - public static final String DEFAULT
    
    Constants that indicates whether this GrailsApplication is running in the default environment
  - public static String ENV_GRAILS_HOME
    
    The name of the GRAILS_HOME environment variable
  - public static final String ENV_KEY
    
    Constant used to resolve the environment via System.getenv(Environment.ENV_KEY).
  - public static String FULL_STACKTRACE
    
    Whether the display of full stack traces is needed
  - public static final String INITIALIZING
    
    Whether Grails is in the middle of bootstrapping or not
  - public static final String INTERACTIVE_MODE_ENABLED
    
    Whether interactive mode is enabled
  - public static String KEY
    
    Constant used to resolve the environment via System.getProperty(Environment.KEY)
  - public static final Environment MAX_VALUE
  - public static final Environment MIN_VALUE
  - public static String RELOAD_ENABLED
    
    Specify whether reloading is enabled for this environment
  - public static final String RELOAD_LOCATION
    
    The location where to reload resources from
  - public static String RUN_ACTIVE
    
    Constant indicating whether run-app or test-app was executed
  - public static final String STANDALONE
    
    Whether Grails has been executed standalone via the static void main method and not loaded in via the container
  - public static MultipleCompilationErrorsException currentCompilationError
  - public static Throwable currentReloadError
- Property Detail
  - Throwable currentReloadError
  - boolean initializing
  - String name
- Method Detail
  - static Object executeForCurrentEnvironment(Closure<?> closure)
    
    Takes an environment specific DSL block like: environments { development {} production {} } And executes the closure that relates to the current environment
    Parameters:
    closure - The top level closure
    Returns:
    The result of the closure execution
  - static Object executeForEnvironment(Environment env, Closure<?> closure)
    
    Takes an environment specific DSL block like: environments { development {} production {} } And executes the closure that relates to the specified environment
    Parameters:
    env - The environment to use
    closure - The top level closure
    Returns:
    The result of the closure execution
  - static Environment getCurrent()
    
    Returns the current environment which is typically either DEVELOPMENT, PRODUCTION or TEST. For custom environments CUSTOM type is returned.
    Returns:
    The current environment.
  - static MultipleCompilationErrorsException getCurrentCompilationError()
  - static Environment getCurrentEnvironment()
    
    See Also:
    getCurrent()
    Returns:
    the current environment
  - static Throwable getCurrentReloadError()
  - static Environment getEnvironment(String shortName)
    
    Returns the environment for the given short name
    Parameters:
    shortName - The short name
    Returns:
    The Environment or null if not known
  - static Closure<?> getEnvironmentSpecificBlock(Closure<?> closure)
    
    Takes an environment specific DSL block like: environments { development {} production {} } And returns the closure that relates to the current environment
    Parameters:
    closure - The top level closure
    Returns:
    The environment specific block or null if non exists
  - static Closure<?> getEnvironmentSpecificBlock(Environment env, Closure<?> closure)
    
    Takes an environment specific DSL block like: environments { development {} production {} } And returns the closure that relates to the specified
    Parameters:
    env - The environment to use
    closure - The top level closure
    Returns:
    The environment specific block or null if non exists
  - static String getGrailsVersion()
    
    Returns:
    The current Grails version
  - String getName()
    
    Returns:
    the name of the environment
  - String getReloadLocation()
    
    Returns:
    Obtains the location to reload resources from
  - boolean hasReloadLocation()
    
    Returns:
    Whether a reload location is specified
  - static boolean isDevelopmentEnvironmentAvailable()
    
    This method will return true if the 'grails-app' directory was found, regardless of whether reloading is active or not
    Returns:
    True if the development sources are present
  - static boolean isDevelopmentMode()
    
    Returns true if the application is running in development mode (within grails run-app)
    Returns:
    true if the application is running in development mode
  - static boolean isDevelopmentRun()
    
    This method will return true the application is run
    Returns:
    True if the development sources are present
  - static boolean isFork()
    
    Whether this is a fork of the Grails command line environment
    Returns:
    True if it is a fork
  - static boolean isInitializing()
    
    Returns:
    Whether interactive mode is enabled
  - static boolean isInteractiveMode()
    
    Returns:
    Whether interactive mode is enabled
  - boolean isReloadEnabled()
    
    Returns:
    Returns whether reload is enabled for the environment
  - static boolean isReloadInProgress()
  - static boolean isReloadingAgentEnabled()
    
    Returns:
    true if the reloading agent is active
  - static boolean isStandalone()
    
    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
    Returns:
    True if it is running standalone outside of a servlet container
  - static boolean isStandaloneDeployed()
    
    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
    Returns:
    True if it is running standalone outside a servlet container from within a JAR or WAR file
  - static boolean isSystemSet()
    
    Returns:
    Return true if the environment has been set as a System property
  - static boolean isWarDeployed()
    
    Check whether the application is deployed
    Returns:
    true if is
  - static boolean isWithinShell()
    
    Returns whether the environment is running within the Grails shell (executed via the 'grails' command line in a terminal window)
    Returns:
    true if is
  - static void reset()
    
    Reset the current environment
  - static void setCurrentReloadError(Throwable currentReloadError)
  - static void setInitializing(boolean initializing)
  - void setName(String name)
    
    Set the name.
    Parameters:
    name - the name

Summary:
Enum constants
Field
Property
Method

[Groovy] Enum Environment

Enum Constants Summary

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Enum Constant Detail

Environment APPLICATION

Environment CUSTOM

Environment DEVELOPMENT

Environment PRODUCTION

Environment TEST

Field Detail

public static final String DEFAULT

public static String ENV_GRAILS_HOME

public static final String ENV_KEY

public static String FULL_STACKTRACE

public static final String INITIALIZING

public static final String INTERACTIVE_MODE_ENABLED

public static String KEY

public static final Environment MAX_VALUE

public static final Environment MIN_VALUE

public static String RELOAD_ENABLED

public static final String RELOAD_LOCATION

public static String RUN_ACTIVE

public static final String STANDALONE

public static MultipleCompilationErrorsException currentCompilationError

public static Throwable currentReloadError

Property Detail

Throwable currentReloadError

boolean initializing

String name

Method Detail

static Object executeForCurrentEnvironment(Closure<?> closure)

static Object executeForEnvironment(Environment env, Closure<?> closure)

static Environment getCurrent()

static MultipleCompilationErrorsException getCurrentCompilationError()

static Environment getCurrentEnvironment()

static Throwable getCurrentReloadError()

static Environment getEnvironment(String shortName)

static Closure<?> getEnvironmentSpecificBlock(Closure<?> closure)

static Closure<?> getEnvironmentSpecificBlock(Environment env, Closure<?> closure)

static String getGrailsVersion()

String getName()

String getReloadLocation()

boolean hasReloadLocation()

static boolean isDevelopmentEnvironmentAvailable()

static boolean isDevelopmentMode()

static boolean isDevelopmentRun()

static boolean isFork()

static boolean isInitializing()

static boolean isInteractiveMode()

boolean isReloadEnabled()

static boolean isReloadInProgress()

static boolean isReloadingAgentEnabled()

static boolean isStandalone()

static boolean isStandaloneDeployed()

static boolean isSystemSet()

static boolean isWarDeployed()

static boolean isWithinShell()

static void reset()

static void setCurrentReloadError(Throwable currentReloadError)

static void setInitializing(boolean initializing)

void setName(String name)