Env (jooby-project 1.6.6 API)

All Superinterfaces:

LifeCycle
```
public interface Env
extends LifeCycle
```
Allows to optimize, customize or apply defaults values for application 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.
`static class`	`Env.ConfigSource` `Env.PropertySource` for `Config`.
`static class`	`Env.MapSource` `Env.PropertySource` for `Map`.
`static interface`	`Env.PropertySource` Property source for `Env.Resolver`
`static class`	`Env.Resolver` Template literal implementation, replaces `${expression}` from a String using a `Config` object.
`static class`	`Env.ServiceKey` Utility class for generating `Key` for named services.

Field Summary

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`com.typesafe.config.Config`	`config()`
`default <T> Optional<T>`	`get(Class<T> key)` Get an object by key or empty when missing.
`<T> Optional<T>`	`get(com.google.inject.Key<T> key)` Get an object by key or empty when missing.
`default <T> Optional<T>`	`ifMode(String name, Supplier<T> fn)` Runs the callback function if the current env matches the given name.
`Locale`	`locale()`
`String`	`name()`
`default String`	`resolve(String text)` Returns a string with all substitutions (the `${foo.bar}` syntax, see the spec) resolved.
`default Env.Resolver`	`resolver()` Creates a new environment `Env.Resolver`.
`Router`	`router()` Application router.
`default Env.ServiceKey`	`serviceKey()`
`default <T> Env`	`set(Class<T> key, T value)` Add a global object.
`<T> Env`	`set(com.google.inject.Key<T> key, T value)` Add a global object.
`List<org.jooby.funzy.Throwing.Consumer<Registry>>`	`startedTasks()`
`List<org.jooby.funzy.Throwing.Consumer<Registry>>`	`startTasks()`
`List<org.jooby.funzy.Throwing.Consumer<Registry>>`	`stopTasks()`
`<T> T`	`unset(com.google.inject.Key<T> key)` Remove a global object.
`Map<String,Function<String,String>>`	`xss()`
`default Function<String,String>`	`xss(String... xss)` Get or chain the required xss functions.
`Env`	`xss(String name, Function<String,String> escaper)` Set/override a XSS escape function.

Methods inherited from interface org.jooby.LifeCycle
lifeCycle, lifeCycleAnnotation, onStart, onStart, onStarted, onStarted, onStop, onStop

- Field Detail
  - DEFAULT
```
static final Env.Builder DEFAULT
```
    Default builder.
- Method Detail
  - name
```
@Nonnull
String name()
```
    Returns:
    
    Env's name.
  - router
```
@Nonnull
Router router()
                throws UnsupportedOperationException
```
    Application router.
    
    Returns:
    
    Available Router.
    
    Throws:
    
    UnsupportedOperationException - if router isn't available.
  - config
```
@Nonnull
com.typesafe.config.Config config()
```
    Returns:
    
    environment properties.
  - locale
```
@Nonnull
Locale locale()
```
    Returns:
    
    Default locale from application.lang.
  - serviceKey
```
@Nonnull
default Env.ServiceKey serviceKey()
```
    Returns:
    
    Utility method for generating keys for named services.
  - resolve
```
@Nonnull
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.
  - resolver
```
@Nonnull
default Env.Resolver resolver()
```
    Creates a new environment Env.Resolver.
    
    Returns:
    
    A resolver object.
  - ifMode
```
@Nonnull
default <T> Optional<T> ifMode(String name,
                                        Supplier<T> fn)
```
    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.
  - xss
```
@Nonnull
Map<String,Function<String,String>> xss()
```
    Returns:
    
    XSS escape functions.
  - xss
```
@Nonnull
default Function<String,String> xss(String... xss)
```
    Get or chain the required xss functions.
    
    Parameters:
    
    xss - XSS to combine.
    
    Returns:
    
    Chain of required xss functions.
  - xss
```
@Nonnull
Env xss(String name,
                 Function<String,String> escaper)
```
    Set/override a XSS escape function.
    
    Parameters:
    
    name - Escape's name.
    
    escaper - Escape function.
    
    Returns:
    
    This environment.
  - startTasks
```
@Nonnull
List<org.jooby.funzy.Throwing.Consumer<Registry>> startTasks()
```
    Returns:
    
    List of start tasks.
  - startedTasks
```
@Nonnull
List<org.jooby.funzy.Throwing.Consumer<Registry>> startedTasks()
```
    Returns:
    
    List of start tasks.
  - stopTasks
```
@Nonnull
List<org.jooby.funzy.Throwing.Consumer<Registry>> stopTasks()
```
    Returns:
    
    List of stop tasks.
  - set
```
@Nonnull
<T> Env set(com.google.inject.Key<T> key,
                     T value)
```
    Add a global object.
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    key - Object key.
    
    value - Object value.
    
    Returns:
    
    This environment.
  - set
```
@Nonnull
default <T> Env set(Class<T> key,
                             T value)
```
    Add a global object.
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    key - Object key.
    
    value - Object value.
    
    Returns:
    
    This environment.
  - unset
```
@Nullable
<T> T unset(com.google.inject.Key<T> key)
```
    Remove a global object.
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    key - Object key.
    
    Returns:
    
    Object value might be null.
  - get
```
@Nonnull
<T> Optional<T> get(com.google.inject.Key<T> key)
```
    Get an object by key or empty when missing.
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    key - Object key.
    
    Returns:
    
    Object valur or empty.
  - get
```
@Nonnull
default <T> Optional<T> get(Class<T> key)
```
    Get an object by key or empty when missing.
    
    Type Parameters:
    
    T - Object type.
    
    Parameters:
    
    key - Object key.
    
    Returns:
    
    Object valur or empty.

Interface Env

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.jooby.LifeCycle

Field Detail

DEFAULT

Method Detail

name

router

config

locale

serviceKey

resolve

resolver

ifMode

xss

xss

xss

startTasks

startedTasks

stopTasks

set

set

unset

get

get