ConfigurationInstances

Simple user-friendly wrapper around Config.

Provides a single type-safe apply method for getting values out from the configuration.

Usage:

val config = Configuration.load("filename.conf").get[Configuration]("objectName")
val intThing = config[Int]("intPropertyName")
val strThing = config[String]("stringPropertyName")

Note that formatting or other problems will throw exceptions.

You can also optionally find correct config items or validate and check their correctness (with Either):

val intOption:Option[Int] = config.option[Int]("intPropertyName")
val strThing: Either[Throwable, String] = config.valid[String]("stringPropertyName")

The Accessor type-classes implement the glue to get the specific type configuration item.

Details on the underlying configuration file specification can be found here: https://github.com/typesafehub/config/blob/master/HOCON.md

Linear Supertypes

AnyRef, Any

Known Subclasses

Configuration

Type Members

trait Accessor[A] extends AnyRef

The type-class that is used to extract a config item of a particular type.
The type-class that is used to extract a config item of a particular type.

Annotations
@implicitNotFound( ... )

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
object Accessor
implicit object BooleanAccessor extends Accessor[Boolean]
implicit def ClassAccessor[A](implicit arg0: ClassTag[A]): Accessor[Class[A]]
implicit object ConfigAccessor extends Accessor[Config]
implicit object ConfigObjectAccessor extends Accessor[ConfigObject]
implicit def ConfigReaderAccessor[A](implicit arg0: config.ConfigReader[A]): Accessor[A]
implicit object ConfigurationAccessor extends Accessor[Configuration]
implicit object DateTimeAccessor extends Accessor[DateTime]
implicit object DurationAccessor extends Accessor[Duration]
implicit object FileAccessor extends Accessor[File]
implicit object IntAccessor extends Accessor[Int]
implicit object ListStringAccessor extends Accessor[List[String]]
implicit object LongAccessor extends Accessor[Long]
implicit def OptionAccessor[A](implicit arg0: Accessor[A]): Accessor[Option[A]]
implicit def OptionTAccessor[F[_], A](implicit arg0: Applicative[F], arg1: Accessor[A]): Accessor[OptionT[F, A]]
implicit def ResultTAccessor[F[_], A](implicit arg0: Applicative[F], arg1: Accessor[A]): Accessor[result.ResultT[F, A]]
implicit object SeqStringAccessor extends Accessor[Seq[String]]
implicit object StringAccessor extends Accessor[String]
implicit object TimeUnitAccessor extends Accessor[TimeUnit]

Accessor for TimeUnits.
Accessor for TimeUnits. This matches what typesafe config expects (see com.typesafe.config.impl.SimpleConfig), and adds some full singular form and medium abbreviation matchers.
def apply(c: Config): Configuration
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asString(c: Configuration): String
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
val failIfMissing: ConfigParseOptions
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def from(f: File): Configuration
def from(s: String): Configuration
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def load(path: String): Configuration

The path is always relative and on the classpath.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Related Doc: package config

trait ConfigurationInstances extends AnyRef

Type Members

trait Accessor[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Accessor

implicit object BooleanAccessor extends Accessor[Boolean]

implicit def ClassAccessor[A](implicit arg0: ClassTag[A]): Accessor[Class[A]]

implicit object ConfigAccessor extends Accessor[Config]

implicit object ConfigObjectAccessor extends Accessor[ConfigObject]

implicit def ConfigReaderAccessor[A](implicit arg0: config.ConfigReader[A]): Accessor[A]

implicit object ConfigurationAccessor extends Accessor[Configuration]

implicit object DateTimeAccessor extends Accessor[DateTime]

implicit object DurationAccessor extends Accessor[Duration]

implicit object FileAccessor extends Accessor[File]

implicit object IntAccessor extends Accessor[Int]

implicit object ListStringAccessor extends Accessor[List[String]]

implicit object LongAccessor extends Accessor[Long]

implicit def OptionAccessor[A](implicit arg0: Accessor[A]): Accessor[Option[A]]

implicit def OptionTAccessor[F[_], A](implicit arg0: Applicative[F], arg1: Accessor[A]): Accessor[OptionT[F, A]]

implicit def ResultTAccessor[F[_], A](implicit arg0: Applicative[F], arg1: Accessor[A]): Accessor[result.ResultT[F, A]]

implicit object SeqStringAccessor extends Accessor[Seq[String]]

implicit object StringAccessor extends Accessor[String]

implicit object TimeUnitAccessor extends Accessor[TimeUnit]

def apply(c: Config): Configuration

final def asInstanceOf[T0]: T0

def asString(c: Configuration): String

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val failIfMissing: ConfigParseOptions

def finalize(): Unit

def from(f: File): Configuration

def from(s: String): Configuration

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def load(path: String): Configuration

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped