Packages

  • package root
    Definition Classes
    root
  • package za
    Definition Classes
    root
  • package co
    Definition Classes
    za
  • package absa
    Definition Classes
    co
  • package commons
    Definition Classes
    absa
  • package config
    Definition Classes
    commons
  • trait ConfTyped extends AnyRef

    Trait that provides a DSL for creating a typed hierarchical configuration object.

    Trait that provides a DSL for creating a typed hierarchical configuration object.

    It provides access to two main abstractions: Conf and Prop

    Example:

    import za.co.absa.commons.config._
    
    object MyAppConfig extends ConfTyped {
    val confSource: java.util.Properties = ???
    
    override val rootPrefix = "com.example"
    
    object Foo extends Conf("foo") {
    object Bar extends Conf("bar") {
    val baz: String = confSource getProperty Prop("baz")
    val qux: String = confSource getProperty Prop("qux")
    }
    }
    }
    
    // somewhere in your application
    
    import MyAppConfig._
    
    val baz = Foo.Bar.baz // mapped to the key "com.example.foo.bar.baz" in the confSource
    val baz = Foo.Bar.qux // mapped to the key "com.example.foo.bar.qux" in the confSource
    

    Note that ConfTyped doesn't impose or depend on the way how the configuration values are loaded. It only provides a convenient way to implicitly construct the configuration key names from the nested object structure.

    The key names are obtained by calling Prop("...") method. It returns a full property key name that reflects the nesting structure of the Conf instances' names, concatenated with dot (.) and prefixed with the rootPrefix if one is provided.

    Another example of usage ConfTyped:

    val props = new java.util.Properties with ConfTyped {
    val foo = new Conf("foo") {
    val bar = new Conf("bar") {
    lazy val baz = getProperty(Prop("baz"))
    }
    }
    }
    
        props.put("foo.bar.baz", "42")
    
    println(props.foo.bar.baz) // prints 42
    

    Definition Classes
    config
  • Conf
  • Prop

object Prop

Attributes
protected
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Prop
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply(name: String)(implicit prefix: Option[Conf] = rootPrefixOpt): String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped