Packages

  • package root
    Definition Classes
    root
  • package net
    Definition Classes
    root
  • package cakesolutions
    Definition Classes
    net
  • package config

    Using Typesafe config we read in and parse configuration files.

    Using Typesafe config we read in and parse configuration files. Paths into these files are then retrieved and type checked using Ficus.

    Using a lightweight DSL, we are able to then check and validate these type checked values. For example, given that the Typesafe configuration:

    top-level-name = "test"
    test {
      nestedVal = 50.68
      nestedDuration = 4 h
      nestedList = []
      context {
        valueInt = 30
        valueStr = "test string"
        valueDuration = 12 ms
        valueStrList = [ "addr1:10", "addr2:20", "addr3:30" ]
        valueDoubleList = [ 10.2, 20, 0.123 ]
      }
    }

    has been parsed and read into an implicit of type Config, then we are able to validate that the value at the path test.nestedVal has type Double and that it satisfies specified size bounds as follows:

    case object ShouldBeAPercentageValue extends Exception
    
    validate[Double]("test.nestedVal", ShouldBeAPercentageValue)(n => 0 <= n && n <= 100)

    If the configuration value at path test.nestedVal fails to pass the percentage bounds check, then Left(ShouldBeAPercentageValue) is returned.

    Likewise, we can enforce that all values in the array at the path test.context.valueStrList match the regular expression pattern [a-z0-9]+:[0-9]+ as follows:

    case object ShouldBeASocketValue extends Exception
    
    validate[List[String]]("test.context.valueStrList", ShouldBeASocketValue)(_.matches("[a-z0-9]+:[0-9]+"))

    In some instances, we may not care about checking the value at a configuration path. In these cases we can use unchecked:

    unchecked[FiniteDuration]("test.nestedDuration")
    Definition Classes
    cakesolutions
  • ConfigError
  • FileNotFound
  • MissingValue
  • NullValue
  • PathSpec
  • RequiredValueNotSet
  • ValueError
  • ValueErrors
  • ValueFailure
  • optional
  • required

sealed trait PathSpec extends AnyRef

Ensures that the specified path has a value defined for it. This may be achieved:

  • at the Typesafe configuration file level: the path must exist and have a non-null value
  • using a sentinal value: the path has the sentinal value if and only if it has not been set or assigned to.
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PathSpec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def value: String

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped