play

Class Configuration

java.lang.Object

play.Configuration

Deprecated.

As of release 2.6.0. Use Config instead.

@Singleton
 @Deprecated
public class Configuration
extends java.lang.Object

The current application configuration.

Constructor Summary

Constructors

Constructor and Description
Configuration(com.typesafe.config.Config conf) Deprecated. Creates a new configuration from a Typesafe Config object.
Configuration(play.api.Configuration conf) Deprecated. Creates a new configuration from a Scala-based configuration.
Configuration(java.util.Map<java.lang.String,java.lang.Object> conf) Deprecated. Creates a new configuration from a map.
Configuration(java.lang.String s) Deprecated. Creates a new configuration by parsing a string in HOCON format.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asMap() Deprecated. Returns the config as a map of plain old Java maps, lists and values.
static Configuration	empty() Deprecated. A new empty configuration.
java.util.Set<java.util.Map.Entry<java.lang.String,com.typesafe.config.ConfigValue>>	entrySet() Deprecated. Returns the config as a set of full paths to config values.
java.lang.Boolean	getBoolean(java.lang.String key) Deprecated. Retrieves a configuration value as a Boolean.
java.lang.Boolean	getBoolean(java.lang.String key, java.lang.Boolean defaultBoolean) Deprecated. Retrieves a configuration value as a Boolean.
java.util.List<java.lang.Boolean>	getBooleanList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Boolean>.
java.util.List<java.lang.Boolean>	getBooleanList(java.lang.String key, java.util.List<java.lang.Boolean> defaultList) Deprecated. Retrieves a configuration value as a List<Boolean>.
java.lang.Long	getBytes(java.lang.String key) Deprecated. Retrieves a configuration value as a Bytes.
java.lang.Long	getBytes(java.lang.String key, java.lang.Long defaultBytes) Deprecated. Retrieves a configuration value as a Bytes.
java.util.List<java.lang.Long>	getBytesList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Long> representing bytes.
java.util.List<java.lang.Long>	getBytesList(java.lang.String key, java.util.List<java.lang.Long> defaultList) Deprecated. Retrieves a configuration value as a List<Long> representing bytes.
Configuration	getConfig(java.lang.String key) Deprecated. Retrieves a sub-configuration, which is a configuration instance containing all keys that start with the given prefix.
java.util.List<Configuration>	getConfigList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Configuration>.
java.util.List<Configuration>	getConfigList(java.lang.String key, java.util.List<Configuration> defaultList) Deprecated. Retrieves a configuration value as a List<Configuration>.
java.lang.Double	getDouble(java.lang.String key) Deprecated. Retrieves a configuration value as an Double.
java.lang.Double	getDouble(java.lang.String key, java.lang.Double defaultDouble) Deprecated. Retrieves a configuration value as an Double.
java.util.List<java.lang.Double>	getDoubleList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Double>.
java.util.List<java.lang.Double>	getDoubleList(java.lang.String key, java.util.List<java.lang.Double> defaultList) Deprecated. Retrieves a configuration value as a List<Double>.
java.lang.Integer	getInt(java.lang.String key) Deprecated. Retrieves a configuration value as an Int.
java.lang.Integer	getInt(java.lang.String key, java.lang.Integer defaultInteger) Deprecated. Retrieves a configuration value as an Int.
java.util.List<java.lang.Integer>	getIntList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Integer>.
java.util.List<java.lang.Integer>	getIntList(java.lang.String key, java.util.List<java.lang.Integer> defaultList) Deprecated. Retrieves a configuration value as a List<Integer>.
java.util.List<java.lang.Object>	getList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Object>.
java.util.List<java.lang.Object>	getList(java.lang.String key, java.util.List<java.lang.Object> defaultList) Deprecated. Retrieves a configuration value as a List<Object>.
java.lang.Long	getLong(java.lang.String key) Deprecated. Retrieves a configuration value as an Long.
java.lang.Long	getLong(java.lang.String key, java.lang.Long defaultLong) Deprecated. Retrieves a configuration value as an Long.
java.util.List<java.lang.Long>	getLongList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Long>.
java.util.List<java.lang.Long>	getLongList(java.lang.String key, java.util.List<java.lang.Long> defaultList) Deprecated. Retrieves a configuration value as a List<Long>.
java.lang.Long	getMilliseconds(java.lang.String key) Deprecated. Retrieves a configuration value as a Milliseconds.
java.lang.Long	getMilliseconds(java.lang.String key, java.lang.Long defaultMilliseconds) Deprecated. Retrieves a configuration value as a Milliseconds.
java.util.List<java.lang.Long>	getMillisecondsList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Long> representing Milliseconds.
java.util.List<java.lang.Long>	getMillisecondsList(java.lang.String key, java.util.List<java.lang.Long> defaultList) Deprecated. Retrieves a configuration value as a List<Long> representing Milliseconds.
java.lang.Long	getNanoseconds(java.lang.String key) Deprecated. Retrieves a configuration value as a Nanoseconds.
java.lang.Long	getNanoseconds(java.lang.String key, java.lang.Long defaultNanoseconds) Deprecated. Retrieves a configuration value as a Nanoseconds.
java.util.List<java.lang.Long>	getNanosecondsList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Long> representing Nanoseconds.
java.util.List<java.lang.Long>	getNanosecondsList(java.lang.String key, java.util.List<java.lang.Long> defaultList) Deprecated. Retrieves a configuration value as a List<Long> representing Nanoseconds.
java.lang.Number	getNumber(java.lang.String key) Deprecated. Retrieves a configuration value as an Number.
java.lang.Number	getNumber(java.lang.String key, java.lang.Number defaultNumber) Deprecated. Retrieves a configuration value as an Number.
java.util.List<java.lang.Number>	getNumberList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Number>.
java.util.List<java.lang.Number>	getNumberList(java.lang.String key, java.util.List<java.lang.Number> defaultList) Deprecated. Retrieves a configuration value as a List<Number>.
java.lang.Object	getObject(java.lang.String key) Deprecated. Retrieves a configuration value as a Object.
java.lang.Object	getObject(java.lang.String key, java.lang.Object defaultObject) Deprecated. Retrieves a configuration value as a Object.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getObjectList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<Map<String, Object>>.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getObjectList(java.lang.String key, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> defaultList) Deprecated. Retrieves a configuration value as a List<Map<String, Object>>.
java.lang.String	getString(java.lang.String key) Deprecated. Retrieves a configuration value as a String.
java.lang.String	getString(java.lang.String key, java.lang.String defaultString) Deprecated. Retrieves a configuration value as a String.
java.util.List<java.lang.String>	getStringList(java.lang.String key) Deprecated. Retrieves a configuration value as a List<String>.
java.util.List<java.lang.String>	getStringList(java.lang.String key, java.util.List<java.lang.String> defaultList) Deprecated. Retrieves a configuration value as a List<Number>.
play.api.Configuration	getWrappedConfiguration() Deprecated.
java.util.Set<java.lang.String>	keys() Deprecated. Retrieves the set of keys available in this configuration.
static Configuration	load(Environment env) Deprecated. Load a new configuration from an environment.
static Configuration	reference() Deprecated. A new reference configuration.
java.lang.RuntimeException	reportError(java.lang.String key, java.lang.String message, java.lang.Throwable e) Deprecated. Creates a configuration error for a specific configuration key.
static Configuration	root() Deprecated. The root configuration.
java.util.Set<java.lang.String>	subKeys() Deprecated. Retrieves the set of direct sub-keys available in this configuration.
com.typesafe.config.Config	underlying() Deprecated. Returns the underlying Typesafe config object.
Configuration	withFallback(Configuration fallback) Deprecated. Extend this configuration with fallback configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(com.typesafe.config.Config conf)

Deprecated.

Creates a new configuration from a Typesafe Config object.

Parameters:

conf - the typesafe config

Configuration

public Configuration(java.util.Map<java.lang.String,java.lang.Object> conf)

Deprecated.

Creates a new configuration from a map.

Parameters:

conf - the configuration map

Configuration

public Configuration(java.lang.String s)

Deprecated.

Creates a new configuration by parsing a string in HOCON format.

Parameters:

s - the HOCON-formatted string

Configuration

@Inject
public Configuration(play.api.Configuration conf)

Deprecated.

Creates a new configuration from a Scala-based configuration.

Parameters:

conf - the scala-based configuration

Method Detail

root

public static Configuration root()

Deprecated.

The root configuration.

Returns:

a Configuration instance

load

public static Configuration load(Environment env)

Deprecated.

Load a new configuration from an environment.

Parameters:

env - the environment used to initialize the created config

Returns:

the created config

empty

public static Configuration empty()

Deprecated.

A new empty configuration.

Returns:

a new empty configuration

reference

public static Configuration reference()

Deprecated.

A new reference configuration.

Returns:

the configuration

getConfig

public Configuration getConfig(java.lang.String key)

Deprecated.

Retrieves a sub-configuration, which is a configuration instance containing all keys that start with the given prefix.

Parameters:

key - The root prefix for this sub configuration.

Returns:

Maybe a new configuration

getString

public java.lang.String getString(java.lang.String key)

Deprecated.

Retrieves a configuration value as a String.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultString)

Deprecated.

Retrieves a configuration value as a String.

Parameters:

key - configuration key (relative to configuration root key)

defaultString - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultString

getMilliseconds

public java.lang.Long getMilliseconds(java.lang.String key)

Deprecated.

Retrieves a configuration value as a Milliseconds.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getMilliseconds

public java.lang.Long getMilliseconds(java.lang.String key,
                                      java.lang.Long defaultMilliseconds)

Deprecated.

Retrieves a configuration value as a Milliseconds.

Parameters:

key - configuration key (relative to configuration root key)

defaultMilliseconds - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultMilliseconds

getNanoseconds

public java.lang.Long getNanoseconds(java.lang.String key)

Deprecated.

Retrieves a configuration value as a Nanoseconds.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getNanoseconds

public java.lang.Long getNanoseconds(java.lang.String key,
                                     java.lang.Long defaultNanoseconds)

Deprecated.

Retrieves a configuration value as a Nanoseconds.

Parameters:

key - configuration key (relative to configuration root key)

defaultNanoseconds - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultMilliseconds

getBytes

public java.lang.Long getBytes(java.lang.String key)

Deprecated.

Retrieves a configuration value as a Bytes.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getBytes

public java.lang.Long getBytes(java.lang.String key,
                               java.lang.Long defaultBytes)

Deprecated.

Retrieves a configuration value as a Bytes.

Parameters:

key - configuration key (relative to configuration root key)

defaultBytes - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultBytes

getDouble

public java.lang.Double getDouble(java.lang.String key)

Deprecated.

Retrieves a configuration value as an Double.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getDouble

public java.lang.Double getDouble(java.lang.String key,
                                  java.lang.Double defaultDouble)

Deprecated.

Retrieves a configuration value as an Double.

Parameters:

key - configuration key (relative to configuration root key)

defaultDouble - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultInteger

getInt

public java.lang.Integer getInt(java.lang.String key)

Deprecated.

Retrieves a configuration value as an Int.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getInt

public java.lang.Integer getInt(java.lang.String key,
                                java.lang.Integer defaultInteger)

Deprecated.

Retrieves a configuration value as an Int.

Parameters:

key - configuration key (relative to configuration root key)

defaultInteger - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultInteger

getLong

public java.lang.Long getLong(java.lang.String key)

Deprecated.

Retrieves a configuration value as an Long.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getLong

public java.lang.Long getLong(java.lang.String key,
                              java.lang.Long defaultLong)

Deprecated.

Retrieves a configuration value as an Long.

Parameters:

key - configuration key (relative to configuration root key)

defaultLong - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultInteger

getNumber

public java.lang.Number getNumber(java.lang.String key)

Deprecated.

Retrieves a configuration value as an Number.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getNumber

public java.lang.Number getNumber(java.lang.String key,
                                  java.lang.Number defaultNumber)

Deprecated.

Retrieves a configuration value as an Number.

Parameters:

key - configuration key (relative to configuration root key)

defaultNumber - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultInteger

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Deprecated.

Retrieves a configuration value as a Boolean.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key,
                                    java.lang.Boolean defaultBoolean)

Deprecated.

Retrieves a configuration value as a Boolean.

Parameters:

key - configuration key (relative to configuration root key)

defaultBoolean - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultBoolean

keys

public java.util.Set<java.lang.String> keys()

Deprecated.

Retrieves the set of keys available in this configuration.

Returns:

the set of keys available in this configuration

subKeys

public java.util.Set<java.lang.String> subKeys()

Deprecated.

Retrieves the set of direct sub-keys available in this configuration.

Returns:

the set of direct sub-keys available in this configuration

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap()

Deprecated.

Returns the config as a map of plain old Java maps, lists and values.

Returns:

The config map

underlying

public com.typesafe.config.Config underlying()

Deprecated.

Returns the underlying Typesafe config object.

Returns:

The config

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,com.typesafe.config.ConfigValue>> entrySet()

Deprecated.

Returns the config as a set of full paths to config values. This is different to asMap() in that it returns ConfigValue objects, and keys are recursively expanded to be pull path keys.

Returns:

The config as an entry set

reportError

public java.lang.RuntimeException reportError(java.lang.String key,
                                              java.lang.String message,
                                              java.lang.Throwable e)

Deprecated.

Creates a configuration error for a specific configuration key.

Parameters:

key - the configuration key, related to this error

message - the error message

e - the optional related exception

Returns:

a configuration exception

getBooleanList

public java.util.List<java.lang.Boolean> getBooleanList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Boolean>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getBooleanList

public java.util.List<java.lang.Boolean> getBooleanList(java.lang.String key,
                                                        java.util.List<java.lang.Boolean> defaultList)

Deprecated.

Retrieves a configuration value as a List<Boolean>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getBytesList

public java.util.List<java.lang.Long> getBytesList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Long> representing bytes.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getBytesList

public java.util.List<java.lang.Long> getBytesList(java.lang.String key,
                                                   java.util.List<java.lang.Long> defaultList)

Deprecated.

Retrieves a configuration value as a List<Long> representing bytes.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getConfigList

public java.util.List<Configuration> getConfigList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Configuration>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getConfigList

public java.util.List<Configuration> getConfigList(java.lang.String key,
                                                   java.util.List<Configuration> defaultList)

Deprecated.

Retrieves a configuration value as a List<Configuration>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getDoubleList

public java.util.List<java.lang.Double> getDoubleList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Double>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getDoubleList

public java.util.List<java.lang.Double> getDoubleList(java.lang.String key,
                                                      java.util.List<java.lang.Double> defaultList)

Deprecated.

Retrieves a configuration value as a List<Double>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getIntList

public java.util.List<java.lang.Integer> getIntList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Integer>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getIntList

public java.util.List<java.lang.Integer> getIntList(java.lang.String key,
                                                    java.util.List<java.lang.Integer> defaultList)

Deprecated.

Retrieves a configuration value as a List<Integer>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getList

public java.util.List<java.lang.Object> getList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Object>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getList

public java.util.List<java.lang.Object> getList(java.lang.String key,
                                                java.util.List<java.lang.Object> defaultList)

Deprecated.

Retrieves a configuration value as a List<Object>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getLongList

public java.util.List<java.lang.Long> getLongList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Long>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getLongList

public java.util.List<java.lang.Long> getLongList(java.lang.String key,
                                                  java.util.List<java.lang.Long> defaultList)

Deprecated.

Retrieves a configuration value as a List<Long>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getMillisecondsList

public java.util.List<java.lang.Long> getMillisecondsList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Long> representing Milliseconds.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getMillisecondsList

public java.util.List<java.lang.Long> getMillisecondsList(java.lang.String key,
                                                          java.util.List<java.lang.Long> defaultList)

Deprecated.

Retrieves a configuration value as a List<Long> representing Milliseconds.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getNanosecondsList

public java.util.List<java.lang.Long> getNanosecondsList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Long> representing Nanoseconds.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getNanosecondsList

public java.util.List<java.lang.Long> getNanosecondsList(java.lang.String key,
                                                         java.util.List<java.lang.Long> defaultList)

Deprecated.

Retrieves a configuration value as a List<Long> representing Nanoseconds.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getNumberList

public java.util.List<java.lang.Number> getNumberList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Number>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getNumberList

public java.util.List<java.lang.Number> getNumberList(java.lang.String key,
                                                      java.util.List<java.lang.Number> defaultList)

Deprecated.

Retrieves a configuration value as a List<Number>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getObjectList

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getObjectList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<Map<String, Object>>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getObjectList

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getObjectList(java.lang.String key,
                                                                                      java.util.List<java.util.Map<java.lang.String,java.lang.Object>> defaultList)

Deprecated.

Retrieves a configuration value as a List<Map<String, Object>>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String key)

Deprecated.

Retrieves a configuration value as a List<String>.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String key,
                                                      java.util.List<java.lang.String> defaultList)

Deprecated.

Retrieves a configuration value as a List<Number>.

Parameters:

key - configuration key (relative to configuration root key)

defaultList - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

getObject

public java.lang.Object getObject(java.lang.String key)

Deprecated.

Retrieves a configuration value as a Object.

Parameters:

key - configuration key (relative to configuration root key)

Returns:

a configuration value or null

getObject

public java.lang.Object getObject(java.lang.String key,
                                  java.lang.Object defaultObject)

Deprecated.

Retrieves a configuration value as a Object.

Parameters:

key - configuration key (relative to configuration root key)

defaultObject - default value if configuration key doesn't exist

Returns:

a configuration value or the defaultList

withFallback

public Configuration withFallback(Configuration fallback)

Deprecated.

Extend this configuration with fallback configuration.

Parameters:

fallback - the configuration to fall back on if no value is found for a key

Returns:

a new configuration that falls back on the provided one

getWrappedConfiguration

public play.api.Configuration getWrappedConfiguration()

Deprecated.