Configuration

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

The requestedKeys method returns all the keys requested.

The public methods to retrieve values are the apply, get, and getOrElse methods.

Examples:

A common pattern is to create an object that extends this class, and reference that object when retrieving values from a path. An additional trait is created that references the custom configuration object, allowing other classes to mix in the additional trait to get access the the configuration methods that use the custom configuration object.

scala> import com.fulcrumgenomics.commons.util.{Configuration, ConfigurationLike}
scala> import com.typesafe.config.{Config, ConfigFactory}
scala> // create an object that stores the config that will be referenced everywhere
scala> object CustomConfiguration extends Configuration(ConfigFactory.load())
scala> // create the trait that can be mixed into other classes to get access to the configuration methods that use the custom configuration object
scala> trait CustomConfiguration extends ConfigurationLike { protected def config: Config = CustomConfiguration.config }
scala> // create a class that mixes in the custom configuration trait
scala> class Foo extends CustomConfiguration { val maybeLong: Option[Long] = this.get[Long]("path.does-not-exist") }
scala> val foo = new Foo()
scala> foo.maybeLong
res0: Option[Long] = None
scala> foo.get("path.does-not-exist")
res1: Option[Long] = None
scala> foo[Long]("path.does-exists-and-is-1")
res2: Long = 1
scala> foo.getOrElse[Long]("path.does-not-exist", 2)
res3: Long = 2

A common pattern is to create an object that extends this class, and reference that object when retrieving values from a path.

scala> import com.fulcrumgenomics.commons.util.Configuration
scala> import com.typesafe.config.{Config, ConfigFactory}
scala> object CustomConfiguration extends Configuration(ConfigFactory.load())
scala> CustomConfiguration.get[Long]("path.does-not-exist")
res0: Option[Long] = None

Linear Supertypes

ConfigurationLike, AnyRef, Any

Instance Constructors

new Configuration(config: Config)

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 Configuration to any2stringadd[Configuration] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Configuration, B)

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

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

Looks up a single value of a specific type in configuration.
Looks up a single value of a specific type in configuration. If the configuration key does not exist, an exception is thrown. If the requested type is not supported, an exception is thrown.
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
Definition Classes
ConfigurationLike
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: Config

The configuration to query.
The configuration to query.

Attributes
protected
Definition Classes
Configuration → ConfigurationLike
def ensuring(cond: (Configuration) ⇒ Boolean, msg: ⇒ Any): Configuration

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

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

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

Implicit information
This member is added by an implicit conversion from Configuration to Ensuring[Configuration] 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
Definition Classes
ConfigurationLike
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 Configuration to StringFormat[Configuration] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def get[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Option[T]

Optionally accesses a configuration value.
Optionally accesses a configuration value. If the value is not present in the configuration a None will be returned, else a Some(T) of the appropriate type.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getOrElse[T](path: String, default: ⇒ T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

Optionally accesses a configuration value.
Optionally accesses a configuration value. If the value is not present in the configuration a the default value will be returned.
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
Definition Classes
ConfigurationLike
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
Definition Classes
Configuration → ConfigurationLike
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def requestedKeys: SortedSet[String]

Returns a sorted set of all keys that have been requested up to this point in time.
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): (Configuration, B)

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

Related Docs: object Configuration | package util

class Configuration extends ConfigurationLike

Instance Constructors

new Configuration(config: Config)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

val config: Config

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

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

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

def ensuring(cond: Boolean): Configuration

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

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

final def getClass(): Class[_]

def getOrElse[T](path: String, default: ⇒ T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

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

def requestedKeys: SortedSet[String]

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): (Configuration, B)

Inherited from ConfigurationLike

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped