Configuration

Instance Constructors

new Configuration(underlying: Config)

underlying
the underlying Config implementation

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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.getBoolean("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.
path
the configuration key, relative to the configuration root key
returns
a configuration value
final def getClass(): Class[_]

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.
path
the root prefix for this sub-configuration
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.
path
the configuration key, relative to the configuration root key
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.getMilliseconds("engine.timeout")
```
The configuration 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.
path
the configuration key, relative to configuration root key
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val underlying: Config

the underlying Config implementation
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

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

Instance Constructors

new Configuration(underlying: Config)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

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

final def getClass(): 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

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def subKeys: Set[String]

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

val underlying: Config

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped