Class/Object

com.typesafe.sslconfig.util

EnrichedConfig

Related Docs: object EnrichedConfig | package util

Permalink

class EnrichedConfig extends AnyRef

Based on PlayConfig, adds some helper methods over underlying Config.

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

Instance Constructors

  1. new EnrichedConfig(underlying: Config)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def get[A](path: String)(implicit loader: ConfigLoader[A]): A

    Permalink

    Get the config at the given path.

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getDeprecated[A](path: String, deprecated: String)(implicit arg0: ConfigLoader[A]): A

    Permalink

    Get a deprecated configuration item.

    Get a deprecated configuration item.

    If the deprecated configuration item is defined, it will be returned, and a warning will be logged.

    Otherwise, the configuration from path will be looked up.

  12. def getDeprecatedWithFallback(path: String, deprecated: String, parent: String = ""): EnrichedConfig

    Permalink

    Get a deprecated configuration.

    Get a deprecated configuration.

    If the deprecated configuration is defined, it will be returned, falling back to the new configuration, and a warning will be logged.

    Otherwise, the configuration from path will be looked up and used as is.

  13. def getOptional[A](path: String)(implicit arg0: ConfigLoader[A]): Option[A]

    Permalink

    Get an optional configuration item.

    Get an optional configuration item.

    If the value of the item is null, this will return None, otherwise returns Some.

    Exceptions thrown

    com.typesafe.config.ConfigException.Missing if the value is undefined (as opposed to null) this will still throw an exception.

  14. def getOptionalDeprecated[A](path: String, deprecated: String)(implicit arg0: ConfigLoader[A]): Option[A]

    Permalink

    Get an optional deprecated configuration item.

    Get an optional deprecated configuration item.

    If the deprecated configuration item is defined, it will be returned, and a warning will be logged.

    Otherwise, the configuration from path will be looked up.

    If the value of the item is null, this will return None, otherwise returns Some.

  15. def getPrototypedMap(path: String, prototypePath: String = "prototype.$path"): Map[String, EnrichedConfig]

    Permalink

    Get a prototyped map of objects.

    Get a prototyped map of objects.

    Each value in the map will fallback to the object loaded from prototype.$path.

  16. def getPrototypedSeq(path: String, prototypePath: String = "prototype.$path"): Seq[EnrichedConfig]

    Permalink

    Get a prototyped sequence of objects.

    Get a prototyped sequence of objects.

    Each object in the sequence will fallback to the object loaded from prototype.$path.

  17. def getSeq[A](path: String)(implicit loader: ConfigLoader[Seq[A]]): Seq[A]

    Permalink
  18. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def reportDeprecation(path: String, deprecated: String): Unit

    Permalink
  24. def reportError(path: String, message: String, e: Option[Throwable] = None): Throwable

    Permalink

    Creates a configuration error for a specific configuration key.

    Creates a configuration error for a specific configuration key.

    For example:

    val configuration = Configuration.load()
    throw configuration.reportError("engine.connectionUrl", "Cannot connect!")
    path

    the configuration key, related to this error

    message

    the error message

    e

    the related exception

    returns

    a configuration exception

  25. def subKeys: Set[String]

    Permalink

    Get the immediate subkeys of this configuration.

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. val underlying: Config

    Permalink
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped