play.api.Configuration

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Configuration
Serializable
Serializable
Product
Equals
AnyRef
Any

Visibility

Public
All

Instance Constructors

new Configuration (underlying: Config)

underlying
the underlying Config implementation

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def != (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
def ++ (other: Configuration): Configuration

Merge 2 configurations.
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def == (arg0: Any): Boolean

Attributes
final
Definition Classes
Any
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def canEqual (arg0: Any): Boolean

Definition Classes
Configuration → Equals
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
Configuration → Equals → AnyRef → Any
def finalize (): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def getBoolean (path: String): Option[Boolean]

Retrieves a configuration value as a Boolean.
Retrieves a configuration value as a Boolean.
For example:
```
val configuration = Configuration.load()
val isEnabled = configuration.getString("engine.isEnabled")
```
A configuration error will be thrown if the configuration value is not a valid Boolean. Authorized vales are yes/no or true/false.
returns
a configuration value
def getBytes (path: String): Option[Long]

Retrieves a configuration value as Bytes.
Retrieves a configuration value as Bytes.
For example:
```
val configuration = Configuration.load()
val maxSize = configuration.getString("engine.maxSize")
```
The configuratioon must be provided as:
```
engine.maxSize = 512k
```
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef → Any
def getConfig (path: String): Option[Configuration]

Retrieves a sub-configuration, i.
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.getSub("engine")
```
The root key of this new configuration will be ‘engine’, and you can access any sub-keys relatively.
returns
a new configuration
def getInt (path: String): Option[Int]

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.
returns
a configuration value
def getMilliseconds (path: String): Option[Long]

Retrieves a configuration value as Milliseconds.
Retrieves a configuration value as Milliseconds.
For example:
```
val configuration = Configuration.load()
val timeout = configuration.getString("engine.timeout")
```
The configuratioon must be provided as:
```
engine.timeout = 1 second
```
def getString (path: String, validValues: Option[Set[String]] = None): Option[String]

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.
validValues
valid values for this configuration
returns
a configuration value
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
def hashCode (): Int

Definition Classes
Configuration → AnyRef → Any
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
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
def ne (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
def productArity : Int

Definition Classes
Configuration → Product
def productElement (arg0: Int): Any

Definition Classes
Configuration → Product
def productIterator : Iterator[Any]

Definition Classes
Product
def productPrefix : String

Definition Classes
Configuration → Product
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!")
```
message
the error message
e
the related exception
returns
a configuration exception
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
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def toString (): String

Definition Classes
Configuration → AnyRef → Any
val underlying : Config

the underlying Config implementation
def wait (): Unit

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

Deprecated Value Members

def productElements : Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
use productIterator instead

Configuration

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

Instance Constructors

new Configuration (underlying: Config)

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def ++ (other: Configuration): Configuration

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def asInstanceOf [T0] : T0

def canEqual (arg0: Any): Boolean

def clone (): AnyRef

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

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

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

def getClass (): java.lang.Class[_]

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

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

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

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

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

def hashCode (): Int

def isInstanceOf [T0] : Boolean

def keys : Set[String]

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

def productArity : Int

def productElement (arg0: Int): Any

def productIterator : Iterator[Any]

def productPrefix : String

def reportError (path: String, message: String, e: Option[Throwable] = None): PlayException

def subKeys : Set[String]

def synchronized [T0] (arg0: ⇒ T0): T0

def toString (): String

val underlying : Config

def wait (): Unit

def wait (arg0: Long, arg1: Int): Unit

def wait (arg0: Long): Unit

Deprecated Value Members

def productElements : Iterator[Any]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any