gololang

Class Runtime

java.lang.Object

gololang.Runtime

public final class Runtime
extends java.lang.Object

A utility module containing functions to interact with the runtime environment.

Method Summary

Modifier and Type	Method and Description
static GoloClassLoader	classLoader() Returns the current thread class loader.
static CliCommand	command() Returns the golo command currently used.
static void	command(CliCommand cmd) Defines the golo command currently used.
static boolean	debugMode() Checks if debug mode is active.
static void	debugMode(boolean v) Defines debug mode.
static java.lang.Class<?>	load(java.lang.Object module) Load a golo file given its path or URL.
static java.lang.Class<?>	load(java.lang.Object module, boolean failOnException) Load a golo file given its path or URL.
static boolean	loadBoolean(java.lang.String prop, java.lang.String env, boolean defaultValue) Get a boolean value from a system property or an environment variable.
static boolean	loadBoolean(java.lang.String value, java.lang.String prop, java.lang.String env, boolean defaultValue) Get a boolean value from a system property or an environment variable.
static boolean	showStackTrace() Checks if the main golo command should print stack traces on error.
static void	showStackTrace(boolean v) Defines if the main golo command should print stack traces on error.
static java.lang.String	version() Returns the current golo version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadBoolean

public static boolean loadBoolean(java.lang.String prop,
                                  java.lang.String env,
                                  boolean defaultValue)

Get a boolean value from a system property or an environment variable.

Equivalent to loadBoolean("true", prop, env, defaultValue)

Parameters:

prop - system property to get the value from, ignored if null.

env - environment variable to get the value from, ignored if null.

defaultValue - value to return if neither the property nor the environment are defined.

loadBoolean

public static boolean loadBoolean(java.lang.String value,
                                  java.lang.String prop,
                                  java.lang.String env,
                                  boolean defaultValue)

Get a boolean value from a system property or an environment variable.

Checks if the property is defined and equals to the value (case insensitive), otherwise checks the environment variable, then use the default value.

Parameters:

value - content of the property.

prop - system property to get the value from, ignored if null.

env - environment variable to get the value from, ignored if null.

defaultValue - value to return if neither the property nor the environment are defined.

Throws:

java.lang.NullPointerException - if value is null and one of the property or environment is defined.

debugMode

public static boolean debugMode()

Checks if debug mode is active.

The initial value is false, but can be redefined using the golo.debug system property, or the GOLO_DEBUG environment variable.

debugMode

public static void debugMode(boolean v)

Defines debug mode.

showStackTrace

public static boolean showStackTrace()

Checks if the main golo command should print stack traces on error.

showStackTrace

public static void showStackTrace(boolean v)

Defines if the main golo command should print stack traces on error.

command

public static void command(CliCommand cmd)

Defines the golo command currently used.

This command is called at init time and should not be called in userland code.

command

public static CliCommand command()

Returns the golo command currently used.

classLoader

public static GoloClassLoader classLoader()

Returns the current thread class loader.

Possibly wrapped in a GoloClassLoader if necessary.

load

public static java.lang.Class<?> load(java.lang.Object module)
                               throws java.lang.Exception

Load a golo file given its path or URL.

Equivalent to load(module, true).

Parameters:

module - can be a String, a java.nio.file.Path, a java.net.URL or a java.net.URI identifying the file to load, or directly a GoloModule.

Returns:

the loaded module class.

Throws:

java.lang.Exception

See Also:

load(Object, boolean)

load

public static java.lang.Class<?> load(java.lang.Object module,
                                      boolean failOnException)
                               throws java.lang.Exception

Load a golo file given its path or URL.

If failOnException is false, any exception is swallowed and null is return.

Parameters:

module - can be a String, a java.nio.file.Path, a java.net.URL or a java.net.URI identifying the file to load, or directly a GoloModule.

failOnException - re-raise exception or not

Returns:

the loaded module class, or null if an error occurred and failOnException is false

Throws:

java.lang.Exception

See Also:

load(Object, boolean)

version

public static java.lang.String version()

Returns the current golo version.