Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package cache

    Contains the Cache access API.

    Contains the Cache access API.

    Definition Classes
    api
  • package cluster
    Definition Classes
    api
  • package controllers
    Definition Classes
    api
  • package data

    Contains data manipulation helpers (typically HTTP form handling)

    Contains data manipulation helpers (typically HTTP form handling)

    import play.api.data._
import play.api.data.Forms._

val taskForm = Form(
  tuple(
    "name" -> text(minLength = 3),
    "dueDate" -> date("yyyy-MM-dd"),
    "done" -> boolean
  )
)
    Definition Classes
    api
  • package db

    Contains the JDBC database access API.

    Contains the JDBC database access API.

    Example, retrieving a connection from the 'customers' datasource:

    val conn = db.getConnection("customers")
    Definition Classes
    api
  • package http

    Contains standard HTTP constants.

    Contains standard HTTP constants. For example:

    val text = ContentTypes.TEXT
val ok = Status.OK
val accept = HeaderNames.ACCEPT
    Definition Classes
    api
  • package i18n

    Contains the internationalisation API.

    Contains the internationalisation API.

    For example, translating a message:

    val msgString = Messages("items.found", items.size)
    Definition Classes
    api
  • package inject

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection support is built on JSR-330, which provides a specification for declaring how dependencies get wired to components. JSR-330 however does not address how components are provided to or located by a DI container. Play's API seeks to address this in a DI container agnostic way.

    The reason for providing this abstraction is so that Play, the modules it provides, and third party modules can all express their bindings in a way that is not specific to any one DI container.

    Components are bound in the DI container. Each binding is identified by a BindingKey, which is typically an interface that the component implements, and may be optionally qualified by a JSR-330 qualifier annotation. A binding key is bound to a BindingTarget, which describes how the implementation of the interface that the binding key represents is constructed or provided. Bindings may also be scoped using JSR-330 scope annotations.

    Bindings are provided by instances of Module.

    Out of the box, Play provides an implementation of this abstraction using Guice.

    Definition Classes
    api
    See also

    The Module class for information on how to provide bindings.

  • package internal
    Definition Classes
    api
  • package libs

    Contains various APIs that are useful while developing web applications.

    Contains various APIs that are useful while developing web applications.

    Definition Classes
    api
  • package mvc

    Contains the Controller/Action/Result API to handle HTTP requests.

    Contains the Controller/Action/Result API to handle HTTP requests.

    For example, a typical controller:

    class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {

  def index = Action {
    Ok("It works!")
  }

}
    Definition Classes
    api
  • package routing
    Definition Classes
    api
  • package templates
    Definition Classes
    api
  • package test

    Contains test helpers.

    Contains test helpers.

    Definition Classes
    api
  • Application
  • ApplicationLoader
  • BuiltInComponents
  • BuiltInComponentsFromContext
  • ConfigLoader
  • Configuration
  • DefaultApplication
  • DefaultMarkerContext
  • Environment
  • Logger
  • LoggerConfigurator
  • LoggerLike
  • Logging
  • LowPriorityMarkerContextImplicits
  • MarkerContext
  • MarkerContexts
  • Mode
  • NoHttpFiltersComponents
  • OptionalDevContext
  • OptionalSourceMapper
  • OptionalSourceMapperProvider
  • Play
  • UnexpectedException

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, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Configuration
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Configuration(underlying: Config)

    underlying

    the underlying Config implementation

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def entrySet: Set[(String, ConfigValue)]

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

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def get[A](path: String)(implicit loader: ConfigLoader[A]): A

    Get the config at the given path.

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

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

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getDeprecated[A](path: String, deprecatedPaths: String*)(implicit arg0: ConfigLoader[A]): A

    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.

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

    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.

  14. def getMillis(path: String): Long

    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
  15. def getNanos(path: String): Long

    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
  16. def getOptional[A](path: String)(implicit loader: ConfigLoader[A]): Option[A]

    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.

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

    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.

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

    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.

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

    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

  20. def has(path: String): Boolean

    Check if the given path exists.

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def keys: Set[String]

    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

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. def reportError(path: String, message: String, e: Option[Throwable] = None): PlayException

    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]

    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
    Definition Classes
    AnyRef
  30. val underlying: Config
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. def withFallback(other: Configuration): Configuration

    Merge two configurations.

    Merge two configurations. The second configuration will act as the fallback for the first configuration.

Deprecated Value Members

  1. def ++(other: Configuration): Configuration

    Merge two configurations.

    Merge two configurations. The second configuration overrides the first configuration. This is the opposite direction of Config's withFallback method.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) Use withFallback instead

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped