ConfigurationLike

Trait that provides useful methods for resolving all kinds of things in configuration. Uses Config to retrieve configuration values in a type-safe way.

The config method must be implemented by a subclass, giving the Config from which to retrieve configuration values.

Overriding the keyRequested method allows a call to be received each time a configuration path is requested.

Overriding the handle method allows a subclass to determine how errors are handled.

Extending the asType method allows a subclass to support additional (possibly custom) types.

The fetch method is used to retrieve configuration values.

Example:

Retrieve a value at a given path:

scala> import com.fulcrumgenomics.commons.util.ConfigurationLike
scala> import com.typesafe.config.{Config, ConfigFactory}
scala> import scala.reflect.runtime.universe.TypeTag
scala> val conf = new ConfigurationLike {
  val config: Config = ConfigFactory.parseString("""a.str = "string", a.int = 2, a.set = [1,2,3]""")
  def get[T : TypeTag](path: String): Option[T] = fetch[T](path)
}
scala> conf.get[String]("a.str")
res0: Option[String] = Some(string)
scala> conf.get[Int]("a.int")
res1: Option[Int] = Some(2)
scala> conf.get[Set[Int]]("a.set")
res2: Option[Set[Int]] = Some(Set(1, 2, 3))
scala> conf.get[Set[Int]]("a.does-not-exist")
res3: Option[Set[Int]] = None
scala> conf.get[Int]("a.set")
java.lang.IllegalArgumentException: Exception retrieving configuration key 'a.set'
...

Linear Supertypes

AnyRef, Any

Known Subclasses

Configuration

Abstract Value Members

abstract def config: Config

The configuration to query.
The configuration to query.

Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ConfigurationLike to any2stringadd[ConfigurationLike] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ConfigurationLike, B)

Implicit information
This member is added by an implicit conversion from ConfigurationLike to ArrowAssoc[ConfigurationLike] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def asType[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

Converts the configuration path to the given type.
Converts the configuration path to the given type. If the requested type is not supported, an exception is thrown. Override this method to support custom types.

Attributes
protected
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (ConfigurationLike) ⇒ Boolean, msg: ⇒ Any): ConfigurationLike

Implicit information
This member is added by an implicit conversion from ConfigurationLike to Ensuring[ConfigurationLike] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ConfigurationLike) ⇒ Boolean): ConfigurationLike

Implicit information
This member is added by an implicit conversion from ConfigurationLike to Ensuring[ConfigurationLike] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ConfigurationLike

Implicit information
This member is added by an implicit conversion from ConfigurationLike to Ensuring[ConfigurationLike] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ConfigurationLike

Implicit information
This member is added by an implicit conversion from ConfigurationLike to Ensuring[ConfigurationLike] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def fetch[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Option[T]

Method to fetch a configuration key that may or may not be present.
Method to fetch a configuration key that may or may not be present.

Attributes
protected
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from ConfigurationLike to StringFormat[ConfigurationLike] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handle(message: ⇒ String, throwable: Option[Throwable] = None): Nothing

Method to allow subclasses to override how errors are handled, e.g.
Method to allow subclasses to override how errors are handled, e.g. by logging or throwing different exceptions.

Attributes
protected
def hashCode(): Int

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

Definition Classes
Any
def keyRequested(path: String): Unit

Method that can be overridden to receive a call each time a configuration path is requested.
Method that can be overridden to receive a call each time a configuration path is requested.

Attributes
protected
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( ... )
def →[B](y: B): (ConfigurationLike, B)

Implicit information
This member is added by an implicit conversion from ConfigurationLike to ArrowAssoc[ConfigurationLike] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Doc: package util

trait ConfigurationLike extends AnyRef

Abstract Value Members

abstract def config: Config

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ConfigurationLike, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def asType[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

def clone(): AnyRef

def ensuring(cond: (ConfigurationLike) ⇒ Boolean, msg: ⇒ Any): ConfigurationLike

def ensuring(cond: (ConfigurationLike) ⇒ Boolean): ConfigurationLike

def ensuring(cond: Boolean, msg: ⇒ Any): ConfigurationLike

def ensuring(cond: Boolean): ConfigurationLike

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fetch[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Option[T]

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def handle(message: ⇒ String, throwable: Option[Throwable] = None): Nothing

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def keyRequested(path: String): Unit

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

def →[B](y: B): (ConfigurationLike, B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConfigurationLike to any2stringadd[ConfigurationLike]

Inherited by implicit conversion StringFormat from ConfigurationLike to StringFormat[ConfigurationLike]

Inherited by implicit conversion Ensuring from ConfigurationLike to Ensuring[ConfigurationLike]

Inherited by implicit conversion ArrowAssoc from ConfigurationLike to ArrowAssoc[ConfigurationLike]

Ungrouped