Packages

object ConfigKey extends ConfigKeyRuntimePlatform

Source
ConfigKey.scala
Linear Supertypes
ConfigKeyRuntimePlatform, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ConfigKey
  2. ConfigKeyRuntimePlatform
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 apply(description: => String): ConfigKey

    Returns a new ConfigKey with the specified description.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. implicit final val configKeyEq: Eq[ConfigKey]

  8. implicit final val configKeyShow: Show[ConfigKey]

  9. final def env(name: String): ConfigKey

    Returns a new ConfigKey for the specified environment variable.

    Returns a new ConfigKey for the specified environment variable.

    Example:
    1. scala> val apiKey = ConfigKey.env("API_KEY")
      apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
      
      scala> apiKey.description
      res0: String = environment variable API_KEY
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def file(path: Path, charset: Charset): ConfigKey

    Returns a new ConfigKey for the specified path and charset.

    Returns a new ConfigKey for the specified path and charset.

    Definition Classes
    ConfigKeyRuntimePlatform
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def prop(name: String): ConfigKey

    Returns a new ConfigKey for the specified system property.

    Returns a new ConfigKey for the specified system property.

    Example:
    1. scala> val apiKey = ConfigKey.prop("api.key")
      apiKey: ConfigKey = ConfigKey(system property api.key)
      
      scala> apiKey.description
      res0: String = system property api.key
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def unapply(key: ConfigKey): Some[String]

    Returns the description for the specified ConfigKey.

    Returns the description for the specified ConfigKey.

    This function enables pattern matching on ConfigKeys.

    Example:
    1. scala> val apiKey = ConfigKey.env("API_KEY")
      apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
      
      scala> apiKey match { case ConfigKey(description) => description }
      res0: String = environment variable API_KEY
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from ConfigKeyRuntimePlatform

Inherited from AnyRef

Inherited from Any

Creating Instances

Type Class Instances

Ungrouped