Class/Object

play.api

Configuration

Related Docs: object Configuration | package api

Permalink

case class Configuration(underlying: Config) extends Product with Serializable

A full configuration set.

The underlying implementation is provided by https://github.com/typesafehub/config.

underlying

the underlying Config implementation

Source
Configuration.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Configuration
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Configuration(underlying: Config)

    Permalink

    underlying

    the underlying Config implementation

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(other: Configuration): Configuration

    Permalink

    Merge two configurations.

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def entrySet: Set[(String, ConfigValue)]

    Permalink

    Returns every path as a set of key to value pairs, by recursively iterating through the config objects.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def get[A](path: String)(implicit loader: ConfigLoader[A]): A

    Permalink

    Get the config at the given path.

  11. def getAndValidate[A](path: String, values: Set[A])(implicit loader: ConfigLoader[A]): A

    Permalink

    Get the config at the given path and validate against a set of valid values.

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getDeprecated[A](path: String, deprecatedPaths: String*)(implicit arg0: ConfigLoader[A]): A

    Permalink

    Get a deprecated configuration item.

    Get a deprecated configuration item.

    If the deprecated configuration item is defined, it will be returned, and a warning will be logged.

    Otherwise, the configuration from path will be looked up.

  14. def getDeprecatedWithFallback(path: String, deprecated: String, parent: String = ""): Configuration

    Permalink

    Get a deprecated configuration.

    Get a deprecated configuration.

    If the deprecated configuration is defined, it will be returned, falling back to the new configuration, and a warning will be logged.

    Otherwise, the configuration from path will be looked up and used as is.

  15. def getMillis(path: String): Long

    Permalink

    Retrieves a configuration value as Milliseconds.

    Retrieves a configuration value as Milliseconds.

    For example:

    val configuration = Configuration.load()
    val timeout = configuration.getMillis("engine.timeout")

    The configuration must be provided as:

    engine.timeout = 1 second
  16. def getNanos(path: String): Long

    Permalink

    Retrieves a configuration value as Milliseconds.

    Retrieves a configuration value as Milliseconds.

    For example:

    val configuration = Configuration.load()
    val timeout = configuration.getNanos("engine.timeout")

    The configuration must be provided as:

    engine.timeout = 1 second
  17. def getOptional[A](path: String)(implicit loader: ConfigLoader[A]): Option[A]

    Permalink

    Get a value that may either not exist or be null.

    Get a value that may either not exist or be null. Note that this is not generally considered idiomatic Config usage. Instead you should define all config keys in a reference.conf file.

  18. def getPrototypedMap(path: String, prototypePath: String = "prototype.$path"): Map[String, Configuration]

    Permalink

    Get a prototyped map of objects.

    Get a prototyped map of objects.

    Each value in the map will fallback to the object loaded from prototype.$path.

  19. def getPrototypedSeq(path: String, prototypePath: String = "prototype.$path"): Seq[Configuration]

    Permalink

    Get a prototyped sequence of objects.

    Get a prototyped sequence of objects.

    Each object in the sequence will fallback to the object loaded from prototype.$path.

  20. def globalError(message: String, e: Option[Throwable] = None): PlayException

    Permalink

    Creates a configuration error for this configuration.

    Creates a configuration error for this configuration.

    For example:

    val configuration = Configuration.load()
    throw configuration.globalError("Missing configuration key: [yop.url]")
    message

    the error message

    e

    the related exception

    returns

    a configuration exception

  21. def has(path: String): Boolean

    Permalink

    Check if the given path exists.

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def keys: Set[String]

    Permalink

    Returns available keys.

    Returns available keys.

    For example:

    val configuration = Configuration.load()
    val keys = configuration.keys
    returns

    the set of keys available in this configuration

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def reportError(path: String, message: String, e: Option[Throwable] = None): PlayException

    Permalink

    Creates a configuration error for a specific configuration key.

    Creates a configuration error for a specific configuration key.

    For example:

    val configuration = Configuration.load()
    throw configuration.reportError("engine.connectionUrl", "Cannot connect!")
    path

    the configuration key, related to this error

    message

    the error message

    e

    the related exception

    returns

    a configuration exception

  28. def subKeys: Set[String]

    Permalink

    Returns sub-keys.

    Returns sub-keys.

    For example:

    val configuration = Configuration.load()
    val subKeys = configuration.subKeys
    returns

    the set of direct sub-keys available in this configuration

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. val underlying: Config

    Permalink

    the underlying Config implementation

  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def getBoolean(path: String): Option[Boolean]

    Permalink

    Retrieves a configuration value as a Boolean.

    Retrieves a configuration value as a Boolean.

    For example:

    val configuration = Configuration.load()
    val isEnabled = configuration.getBoolean("engine.isEnabled")

    A configuration error will be thrown if the configuration value is not a valid Boolean. Authorized values are yes/no or true/false.

    path

    the configuration key, relative to the configuration root key

    returns

    a configuration value

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Boolean] with reference config entry

  2. def getBooleanList(path: String): Option[List[Boolean]]

    Permalink

    Retrieves a configuration value as a List of Boolean.

    Retrieves a configuration value as a List of Boolean.

    For example:

    val configuration = Configuration.load()
    val switches = configuration.getBooleanList("board.switches")

    The configuration must be provided as:

    board.switches = [true, true, false]

    A configuration error will be thrown if the configuration value is not a valid Boolean. Authorized values are yes/no or true/false.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getBooleanList with reference config entry

  3. def getBooleanSeq(path: String): Option[Seq[Boolean]]

    Permalink

    Retrieves a configuration value as a Seq of Boolean.

    Retrieves a configuration value as a Seq of Boolean.

    For example:

    val configuration = Configuration.load()
    val switches = configuration.getBooleanSeq("board.switches")

    The configuration must be provided as:

    board.switches = [true, true, false]

    A configuration error will be thrown if the configuration value is not a valid Boolean. Authorized values are yes/no or true/false.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Boolean]] with reference config entry

  4. def getBytes(path: String): Option[Long]

    Permalink

    Retrieves a configuration value as Bytes.

    Retrieves a configuration value as Bytes.

    For example:

    val configuration = Configuration.load()
    val maxSize = configuration.getBytes("engine.maxSize")

    The configuration must be provided as:

    engine.maxSize = 512k
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getBytes with reference config entry

  5. def getBytesList(path: String): Option[List[Long]]

    Permalink

    Retrieves a configuration value as a List of Bytes.

    Retrieves a configuration value as a List of Bytes.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getBytesList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [512k, 256k, 256k]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getBytesList with reference config entry

  6. def getBytesSeq(path: String): Option[Seq[Long]]

    Permalink

    Retrieves a configuration value as a Seq of Bytes.

    Retrieves a configuration value as a Seq of Bytes.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getBytesSeq("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [512k, 256k, 256k]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getBytesList with reference config entry

  7. def getConfig(path: String): Option[Configuration]

    Permalink

    Retrieves a sub-configuration, i.e.

    Retrieves a sub-configuration, i.e. a configuration instance containing all keys starting with a given prefix.

    For example:

    val configuration = Configuration.load()
    val engineConfig = configuration.getConfig("engine")

    The root key of this new configuration will be ‘engine’, and you can access any sub-keys relatively.

    path

    the root prefix for this sub-configuration

    returns

    a new configuration

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Configuration] with reference config entry

  8. def getConfigList(path: String): Option[List[Configuration]]

    Permalink

    Retrieves a List of sub-configurations, i.e.

    Retrieves a List of sub-configurations, i.e. a configuration instance for each key that matches the path.

    For example:

    val configuration = Configuration.load()
    val engineConfigs = configuration.getConfigList("engine")

    The root key of this new configuration will be "engine", and you can access any sub-keys relatively.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getConfigList with reference config entry

  9. def getConfigSeq(path: String): Option[Seq[Configuration]]

    Permalink

    Retrieves a Seq of sub-configurations, i.e.

    Retrieves a Seq of sub-configurations, i.e. a configuration instance for each key that matches the path.

    For example:

    val configuration = Configuration.load()
    val engineConfigs = configuration.getConfigSeq("engine")

    The root key of this new configuration will be "engine", and you can access any sub-keys relatively.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getConfigList with reference config entry

  10. def getDouble(path: String): Option[Double]

    Permalink

    Retrieves a configuration value as a Double.

    Retrieves a configuration value as a Double.

    For example:

    val configuration = Configuration.load()
    val population = configuration.getDouble("world.population")

    A configuration error will be thrown if the configuration value is not a valid Double.

    path

    the configuration key, relative to the configuration root key

    returns

    a configuration value

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Double] with reference config entry

  11. def getDoubleList(path: String): Option[List[Double]]

    Permalink

    Retrieves a configuration value as a List of Double.

    Retrieves a configuration value as a List of Double.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getDoubleList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [5.0, 3.34, 2.6]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getDoubleList with reference config entry

  12. def getDoubleSeq(path: String): Option[Seq[Double]]

    Permalink

    Retrieves a configuration value as a Seq of Double.

    Retrieves a configuration value as a Seq of Double.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getDoubleSeq("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [5.0, 3.34, 2.6]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Double]] with reference config entry

  13. def getInt(path: String): Option[Int]

    Permalink

    Retrieves a configuration value as an Int.

    Retrieves a configuration value as an Int.

    For example:

    val configuration = Configuration.load()
    val poolSize = configuration.getInt("engine.pool.size")

    A configuration error will be thrown if the configuration value is not a valid Int.

    path

    the configuration key, relative to the configuration root key

    returns

    a configuration value

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Int] with reference config entry

  14. def getIntList(path: String): Option[List[Integer]]

    Permalink

    Retrieves a configuration value as a List of Integer.

    Retrieves a configuration value as a List of Integer.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getIntList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [100, 500, 2]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getIntList with reference config entry

  15. def getIntSeq(path: String): Option[Seq[Integer]]

    Permalink

    Retrieves a configuration value as a Seq of Integer.

    Retrieves a configuration value as a Seq of Integer.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getIntSeq("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [100, 500, 2]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Int]] with reference config entry

  16. def getList(path: String): Option[ConfigList]

    Permalink

    Gets a list value (with any element type) as a ConfigList, which implements java.util.List<ConfigValue>.

    Gets a list value (with any element type) as a ConfigList, which implements java.util.List<ConfigValue>.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = ["foo", "bar"]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[ConfigList] with reference config entry

  17. def getLong(path: String): Option[Long]

    Permalink

    Retrieves a configuration value as a Long.

    Retrieves a configuration value as a Long.

    For example:

    val configuration = Configuration.load()
    val duration = configuration.getLong("timeout.duration")

    A configuration error will be thrown if the configuration value is not a valid Long.

    path

    the configuration key, relative to the configuration root key

    returns

    a configuration value

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Long] with reference config entry

  18. def getLongList(path: String): Option[List[Long]]

    Permalink

    Retrieves a configuration value as a List of Long.

    Retrieves a configuration value as a List of Long.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getLongList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [10000000000000, 500, 2000]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getLongList with reference config entry

  19. def getLongSeq(path: String): Option[Seq[Long]]

    Permalink

    Retrieves a configuration value as a Seq of Long.

    Retrieves a configuration value as a Seq of Long.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getLongSeq("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [10000000000000, 500, 2000]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Long]] with reference config entry

  20. def getMilliseconds(path: String): Option[Long]

    Permalink

    Retrieves a configuration value as Milliseconds.

    Retrieves a configuration value as Milliseconds.

    For example:

    val configuration = Configuration.load()
    val timeout = configuration.getMilliseconds("engine.timeout")

    The configuration must be provided as:

    engine.timeout = 1 second
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use getMillis with reference config entry

  21. def getMillisecondsList(path: String): Option[List[Long]]

    Permalink

    Retrieves a configuration value as List of Milliseconds.

    Retrieves a configuration value as List of Milliseconds.

    For example:

    val configuration = Configuration.load()
    val timeouts = configuration.getMillisecondsList("engine.timeouts")

    The configuration must be provided as:

    engine.timeouts = [1 second, 1 second]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getMillisecondsList with reference config entry

  22. def getMillisecondsSeq(path: String): Option[Seq[Long]]

    Permalink

    Retrieves a configuration value as Seq of Milliseconds.

    Retrieves a configuration value as Seq of Milliseconds.

    For example:

    val configuration = Configuration.load()
    val timeouts = configuration.getMillisecondsSeq("engine.timeouts")

    The configuration must be provided as:

    engine.timeouts = [1 second, 1 second]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Duration]].map(_.toMillis) with reference config entry

  23. def getNanoseconds(path: String): Option[Long]

    Permalink

    Retrieves a configuration value as Nanoseconds.

    Retrieves a configuration value as Nanoseconds.

    For example:

    val configuration = Configuration.load()
    val timeout = configuration.getNanoseconds("engine.timeout")

    The configuration must be provided as:

    engine.timeout = 1 second
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use getNanos with reference config entry

  24. def getNanosecondsList(path: String): Option[List[Long]]

    Permalink

    Retrieves a configuration value as List of Nanoseconds.

    Retrieves a configuration value as List of Nanoseconds.

    For example:

    val configuration = Configuration.load()
    val timeouts = configuration.getNanosecondsList("engine.timeouts")

    The configuration must be provided as:

    engine.timeouts = [1 second, 1 second]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getNanosecondsList with reference config entry

  25. def getNanosecondsSeq(path: String): Option[Seq[Long]]

    Permalink

    Retrieves a configuration value as Seq of Nanoseconds.

    Retrieves a configuration value as Seq of Nanoseconds.

    For example:

    val configuration = Configuration.load()
    val timeouts = configuration.getNanosecondsSeq("engine.timeouts")

    The configuration must be provided as:

    engine.timeouts = [1 second, 1 second]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Duration]].map(_.toMillis) with reference config entry

  26. def getNumber(path: String): Option[Number]

    Permalink

    Retrieves a configuration value as a Number.

    Retrieves a configuration value as a Number.

    For example:

    val configuration = Configuration.load()
    val counter = configuration.getNumber("foo.counter")

    A configuration error will be thrown if the configuration value is not a valid Number.

    path

    the configuration key, relative to the configuration root key

    returns

    a configuration value

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Number] with reference config entry

  27. def getNumberList(path: String): Option[List[Number]]

    Permalink

    Retrieves a configuration value as a List of Number.

    Retrieves a configuration value as a List of Number.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getNumberList("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [50, 500, 5000]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getNumberList with reference config entry

  28. def getNumberSeq(path: String): Option[Seq[Number]]

    Permalink

    Retrieves a configuration value as a Seq of Number.

    Retrieves a configuration value as a Seq of Number.

    For example:

    val configuration = Configuration.load()
    val maxSizes = configuration.getNumberSeq("engine.maxSizes")

    The configuration must be provided as:

    engine.maxSizes = [50, 500, 5000]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[Number]] with reference config entry

  29. def getObject(path: String): Option[ConfigObject]

    Permalink

    Retrieves a ConfigObject for this path, which implements Map<String,ConfigValue>

    Retrieves a ConfigObject for this path, which implements Map<String,ConfigValue>

    For example:

    val configuration = Configuration.load()
    val engineProperties = configuration.getObject("engine.properties")

    The configuration must be provided as:

    engine.properties = {id: 1, power: 5}
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[ConfigObject] with reference config entry

  30. def getObjectList(path: String): Option[List[_ <: ConfigObject]]

    Permalink

    Retrieves a configuration value as a List of ConfigObject.

    Retrieves a configuration value as a List of ConfigObject.

    For example:

    val configuration = Configuration.load()
    val engineProperties = configuration.getObjectList("engine.properties")

    The configuration must be provided as:

    engine.properties = [{id: 5, power: 3}, {id: 6, power: 20}]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getObjectList with reference config entry

  31. def getString(path: String, validValues: Option[Set[String]] = None): Option[String]

    Permalink

    Retrieves a configuration value as a String.

    Retrieves a configuration value as a String.

    This method supports an optional set of valid values:

    val config = Configuration.load()
    val mode = config.getString("engine.mode", Some(Set("dev","prod")))

    A configuration error will be thrown if the configuration value does not match any of the required values.

    path

    the configuration key, relative to configuration root key

    validValues

    valid values for this configuration

    returns

    a configuration value

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[String] or getAndValidate[String] with reference config entry

  32. def getStringList(path: String): Option[List[String]]

    Permalink

    Retrieves a configuration value as a List of String.

    Retrieves a configuration value as a List of String.

    For example:

    val configuration = Configuration.load()
    val names = configuration.getStringList("names")

    The configuration must be provided as:

    names = ["Jim", "Bob", "Steve"]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use underlying.getStringList with reference config entry

  33. def getStringSeq(path: String): Option[Seq[String]]

    Permalink

    Retrieves a configuration value as a Seq of String.

    Retrieves a configuration value as a Seq of String.

    For example:

    val configuration = Configuration.load()
    val names = configuration.getStringSeq("names")

    The configuration must be provided as:

    names = ["Jim", "Bob", "Steve"]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use get[Seq[String]] with reference config entry

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped