org.jooby

Interface Env

public interface Env

Allows to optimize, customize or apply defaults values for services.

A env is represented by it's name. For example: dev, prod, etc... A dev env is special and a module provider could do some special configuration for development, like turning off a cache, reloading of resources, etc.

Same is true for not dev environments. For example, a module provider might create a high performance connection pool, caches, etc.

By default env is set to dev, but you can change it by setting the application.env property to anything else.

Since:

0.1.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Env.Builder Build an jooby environment.

Field Summary

Fields

Modifier and Type	Field and Description
static Env.Builder	DEFAULT Default builder.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
default <T> Optional<T>	ifMode(String name, ExSupplier<T> fn) Runs the callback function if the current env matches the given name.
String	name()
default String	resolve(String text) Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved.
default String	resolve(String text, com.typesafe.config.Config source) Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved.
default String	resolve(String text, com.typesafe.config.Config source, String startDelimiter, String endDelimiter) Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved.
default String	resolve(String text, String startDelimiter, String endDelimiter) Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved.
default <T> Switch<String,T>	when(Predicate<String> predicate, T result) Produces a Switch of the current Env.
default <T> Switch<String,T>	when(String name, ExSupplier<T> fn) Produces a Switch of the current Env.
default <T> Switch<String,T>	when(String name, T result) Produces a Switch of the current Env.

Field Detail

DEFAULT

static final Env.Builder DEFAULT

Default builder.

Method Detail

name

String name()

Returns:

Env's name.

config

com.typesafe.config.Config config()

Returns:

environment properties.

resolve

default String resolve(String text)

Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved. Substitutions are looked up using the config() as the root object, that is, a substitution ${foo.bar} will be replaced with the result of getValue("foo.bar").

Parameters:

text - Text to process.

Returns:

A processed string.

resolve

default String resolve(String text,
                       String startDelimiter,
                       String endDelimiter)

Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved. Substitutions are looked up using the config() as the root object, that is, a substitution ${foo.bar} will be replaced with the result of getValue("foo.bar").

Parameters:

text - Text to process.

startDelimiter - Start delimiter.

endDelimiter - End delimiter.

Returns:

A processed string.

resolve

default String resolve(String text,
                       com.typesafe.config.Config source)

Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved. Substitutions are looked up using the source param as the root object, that is, a substitution ${foo.bar} will be replaced with the result of getValue("foo.bar").

Parameters:

text - Text to process.

source - The source config to use.

Returns:

A processed string.

resolve

default String resolve(String text,
                       com.typesafe.config.Config source,
                       String startDelimiter,
                       String endDelimiter)

Returns a string with all substitutions (the ${foo.bar} syntax, see the spec) resolved. Substitutions are looked up using the source param as the root object, that is, a substitution ${foo.bar} will be replaced with the result of getValue("foo.bar").

Parameters:

text - Text to process.

source - The source config to use

startDelimiter - Start delimiter.

endDelimiter - End delimiter.

Returns:

A processed string.

ifMode

default <T> Optional<T> ifMode(String name,
                               ExSupplier<T> fn)
                        throws Exception

Runs the callback function if the current env matches the given name.

Type Parameters:

T - A resulting type.

Parameters:

name - A name to test for.

fn - A callback function.

Returns:

A resulting object.

Throws:

Exception - If something fails.

when

default <T> Switch<String,T> when(String name,
                                  ExSupplier<T> fn)

Produces a Switch of the current Env.

   String accessKey = env.when("dev", ()  -> "1234")
                          .when("stage", ()  -> "4321")
                          .when("prod", ()  -> "abc")
                          .get();
 

Type Parameters:

T - A resulting type.

Parameters:

name - A name to test for.

fn - A callback function.

Returns:

A new switch.

when

default <T> Switch<String,T> when(String name,
                                  T result)

Produces a Switch of the current Env.

   String accessKey = env.when("dev", "1234")
                          .when("stage", "4321")
                          .when("prod", "abc")
                          .get();
 

Type Parameters:

T - A resulting type.

Parameters:

name - A name to test for.

result - A constant value to return.

Returns:

A new switch.

when

default <T> Switch<String,T> when(Predicate<String> predicate,
                                  T result)

Produces a Switch of the current Env.

   String accessKey = env.when("dev", ()  -> "1234")
                          .when("stage", ()  -> "4321")
                          .when("prod", ()  -> "abc")
                          .get();
 

Type Parameters:

T - A resulting type.

Parameters:

predicate - A predicate to use.

result - A constant value to return.

Returns:

A new switch.