griffon.core.env

Enum Environment

java.lang.Object

java.lang.Enum<Environment>

griffon.core.env.Environment

All Implemented Interfaces:

Serializable, Comparable<Environment>

public enum Environment
extends Enum<Environment>

An enum that represents the current environment

Author:

Graeme Rocher (Grails 1.1)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM A custom environment
DEVELOPMENT The development environment
PRODUCTION The production environment
TEST The test environment

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT Constants that indicates whether this GriffonApplication is running in the default environment
static String	KEY Constant used to resolve the environment via System.getProperty(Environment.KEY)

Method Summary

Methods

Modifier and Type	Method and Description
static Environment	getCurrent() Returns the current environment which is typically either DEVELOPMENT, PRODUCTION or TEST.
static Environment	getEnvironment(String shortName) Returns the environment for the given short name
static String	getEnvironmentShortName()
String	getName()
static boolean	isSystemSet()
void	setName(String name)
static Environment	valueOf(String name) Returns the enum constant of this type with the specified name.
static Environment[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEVELOPMENT

public static final Environment DEVELOPMENT

The development environment

PRODUCTION

public static final Environment PRODUCTION

The production environment

TEST

public static final Environment TEST

The test environment

CUSTOM

public static final Environment CUSTOM

A custom environment

Field Detail

KEY

public static final String KEY

Constant used to resolve the environment via System.getProperty(Environment.KEY)

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

Constants that indicates whether this GriffonApplication is running in the default environment

See Also:

Constant Field Values

Method Detail

values

public static Environment[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Environment c : Environment.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Environment valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCurrent

@Nonnull
public 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.

isSystemSet

public static boolean isSystemSet()

Returns:

Return true if the environment has been set as a System property

getEnvironment

@Nullable
public static Environment getEnvironment(@Nullable
                                  String shortName)

Returns the environment for the given short name

Parameters:

shortName - The short name

Returns:

The Environment or null if not known

getName

@Nonnull
public String getName()

Returns:

The name of the environment

setName

public void setName(String name)

getEnvironmentShortName

@Nonnull
public static String getEnvironmentShortName()