griffon.core.env

Enum RunMode

java.lang.Object

java.lang.Enum<RunMode>

griffon.core.env.RunMode

All Implemented Interfaces:

Serializable, Comparable<RunMode>

public enum RunMode
extends Enum<RunMode>

An enum that represents the current running mode.

Since:

2.0.0

Author:

Andres Almiray

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLET
CUSTOM
STANDALONE
WEBSTART

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static RunMode	getCurrent() Returns the current RunMode which is typically either STANDALONE, WEBSTART or APPLET.
String	getName()
static RunMode	getRunMode(String shortName) Returns the running mode for the given short name
static boolean	isSystemSet()
void	setName(String name)
static RunMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RunMode[]	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

STANDALONE

public static final RunMode STANDALONE

WEBSTART

public static final RunMode WEBSTART

APPLET

public static final RunMode APPLET

CUSTOM

public static final RunMode CUSTOM

Field Detail

KEY

public static final String KEY

Constant used to resolve the runMode via System.getProperty(RunMode.KEY)

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

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

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

public static RunMode getCurrent()

Returns the current RunMode which is typically either STANDALONE, WEBSTART or APPLET. For custom running modes CUSTOM type is returned.

Returns:

The current runMode.

isSystemSet

public static boolean isSystemSet()

Returns:

Return true if the running mode has been set as a System property

getRunMode

public static RunMode getRunMode(String shortName)

Returns the running mode for the given short name

Parameters:

shortName - The short name

Returns:

The RunMode or null if not known

getName

public String getName()

Returns:

The name of the running mode

setName

public void setName(String name)