com.fredhopper.environment

Enum RuntimeMode

java.lang.Object

java.lang.Enum<RuntimeMode>

com.fredhopper.environment.RuntimeMode

All Implemented Interfaces:

Serializable, Comparable<RuntimeMode>

public enum RuntimeMode
extends Enum<RuntimeMode>

A general notion of the mode of the runtime of the application.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEVELOPMENT Refers to a runtime that is used for development times.
PRODUCTION Refers to a common production environment.
TEST Refers to a runtime that is used in the context of testing.
UNKNOWN An unknown runtime.

Method Summary

Modifier and Type	Method and Description
static RuntimeMode	fromEnvironment(Environment e) Determine the runtime mode.
static RuntimeMode	fromEnvironmentName(String name)
static RuntimeMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RuntimeMode[]	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

PRODUCTION

public static final RuntimeMode PRODUCTION

Refers to a common production environment.

TEST

public static final RuntimeMode TEST

Refers to a runtime that is used in the context of testing.

DEVELOPMENT

public static final RuntimeMode DEVELOPMENT

Refers to a runtime that is used for development times.

UNKNOWN

public static final RuntimeMode UNKNOWN

An unknown runtime. See Environment.getEnvironmentName().

Method Detail

values

public static RuntimeMode[] 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 (RuntimeMode c : RuntimeMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static RuntimeMode 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

fromEnvironment

public static RuntimeMode fromEnvironment(Environment e)

Determine the runtime mode.

Parameters:

e - the Environment instance

Returns:

the result of fromEnvironmentName(String) from the name of the environment

fromEnvironmentName

public static RuntimeMode fromEnvironmentName(String name)

Parameters:

name - the name of the runtime mode

Returns:

the resolved runtime mode or UNKNOWN if an exception occurs.