com.mle.util

ConfigReader

Related Doc: package util

trait ConfigReader[T] extends AnyRef

Reads configuration data from various local sources.

Users of this class mainly use load to load the config when needed. The rest of the methods can be overridden for customization.

T

type of config

Linear Supertypes
AnyRef, Any
Known Subclasses
BaseConfigReader
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConfigReader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def fromEnv: T

  2. abstract def fromEnvOpt: Option[T]

  3. abstract def fromMapOpt(map: Map[String, String]): Option[T]

  4. abstract def fromPath(path: Path): T

  5. abstract def fromPathOpt(path: Path): Option[T]

  6. abstract def fromResource(res: String): T

  7. abstract def fromResourceOpt(res: String): Option[T]

  8. abstract def fromUserHome: T

  9. abstract def load: T

    Attempts to read the config.

    Attempts to read the config.

    returns

    the config

    Exceptions thrown

    com.mle.exception.ResourceNotFoundException if no valid config is found in any of the searched locations

  10. abstract def loadOpt: Option[T]

    Attempts to read the config.

    Attempts to read the config. Override this method to customize a) the locations from which the config is read and b) the order in which the locations are read.

    returns

    the config wrapped in an Option if successfully read, None otherwise

  11. abstract def resourceCredential: String

  12. abstract def userHomeConfPath: Path

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
    @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

  10. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  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

  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  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
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped