io.jooby

Class EnvironmentOptions

java.lang.Object

io.jooby.EnvironmentOptions

public class EnvironmentOptions
extends Object

Available environment options.

Since:

2.0.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
EnvironmentOptions() Creates environment options.

Method Summary

Modifier and Type	Method and Description
List<String>	getActiveNames() Active environment names or fallback and read them from system property: application.env.
String	getBasedir() Base directory to use or null for default.
ClassLoader	getClassLoader() Class loader.
ClassLoader	getClassLoader(ClassLoader defaultClassLoader) Class loader.
String	getFilename() Configuration file name.
EnvironmentOptions	setActiveNames(List<String> activeNames) Set active environment names.
EnvironmentOptions	setActiveNames(String... activeNames) Set active environment names.
EnvironmentOptions	setBasedir(Path basedir) Set base dir.
EnvironmentOptions	setBasedir(String basedir) Set base dir.
EnvironmentOptions	setClassLoader(ClassLoader classLoader) Set class loader.
EnvironmentOptions	setFilename(String filename) Set file name.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentOptions

public EnvironmentOptions()

Creates environment options. Default application file name is: application.conf.

Method Detail

getActiveNames

public List<String> getActiveNames()

Active environment names or fallback and read them from system property: application.env.

Returns:

Active environment names.

setActiveNames

@Nonnull
public EnvironmentOptions setActiveNames(@Nonnull
                                                  String... activeNames)

Set active environment names.

Parameters:

activeNames - Active environment names.

Returns:

This options.

setActiveNames

@Nonnull
public EnvironmentOptions setActiveNames(@Nonnull
                                                  List<String> activeNames)

Set active environment names.

Parameters:

activeNames - Active environment names.

Returns:

This options.

getClassLoader

@Nonnull
public ClassLoader getClassLoader()

Class loader.

Returns:

Class loader.

getClassLoader

@Nonnull
public ClassLoader getClassLoader(@Nonnull
                                           ClassLoader defaultClassLoader)

Class loader.

Parameters:

defaultClassLoader - Default classloader is none was set.

Returns:

Class loader.

setClassLoader

@Nonnull
public EnvironmentOptions setClassLoader(@Nonnull
                                                  ClassLoader classLoader)

Set class loader.

Parameters:

classLoader - Class loader.

Returns:

This options.

getBasedir

@Nullable
public String getBasedir()

Base directory to use or null for default.

Returns:

Base directory to use or null for default.s

getFilename

@Nonnull
public String getFilename()

Configuration file name.

Returns:

Configuration file name.

setBasedir

@Nonnull
public EnvironmentOptions setBasedir(@Nullable
                                              String basedir)

Set base dir.

Parameters:

basedir - Base dir. Classpath folder or file system directory.

Returns:

This options.

setBasedir

@Nonnull
public EnvironmentOptions setBasedir(@Nullable
                                              Path basedir)

Set base dir.

Parameters:

basedir - Base dir.

Returns:

This options.

setFilename

@Nonnull
public EnvironmentOptions setFilename(@Nonnull
                                               String filename)

Set file name.

Parameters:

filename - File name with extension. Supported extensions are: .properties, .conf and .json.

Returns:

This environment.