final case class Described[A](config: Config[A], description: String) extends Composite[A] with Product with Serializable
- Alphabetic
- By Inheritance
- Described
- Serializable
- Product
- Equals
- Composite
- Config
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ++[B](that: => Config[B])(implicit zippable: Zippable[A, B]): Config[Out]
Returns a new config that is the composition of this config and the specified config.
Returns a new config that is the composition of this config and the specified config.
- Definition Classes
- Config
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ??(label: => String): Config[A]
Adds a description to this configuration, which is intended for humans.
Adds a description to this configuration, which is intended for humans.
- Definition Classes
- Config
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val config: Config[A]
- val description: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def map[B](f: (A) => B): Config[B]
Returns a new config whose structure is the same as this one, but which produces a different Scala value, constructed using the specified function.
Returns a new config whose structure is the same as this one, but which produces a different Scala value, constructed using the specified function.
- Definition Classes
- Config
- def mapAttempt[B](f: (A) => B): Config[B]
Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified function, which may throw exceptions that will be translated into validation errors.
Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified function, which may throw exceptions that will be translated into validation errors.
- Definition Classes
- Config
- def mapOrFail[B](f: (A) => Either[Error, B]): Config[B]
Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified fallible function.
Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified fallible function.
- Definition Classes
- Config
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nested(name: => String, names: String*): Config[A]
Returns a new config that has this configuration nested as a property of the specified name.
Returns a new config that has this configuration nested as a property of the specified name.
- Definition Classes
- Config
- def nested(name: => String): Config[A]
Returns a new config that has this configuration nested as a property of the specified name.
Returns a new config that has this configuration nested as a property of the specified name.
- Definition Classes
- Config
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def optional: Config[Option[A]]
Returns an optional version of this config, which will be
Noneif the data is missing from configuration, andSomeotherwise.Returns an optional version of this config, which will be
Noneif the data is missing from configuration, andSomeotherwise.- Definition Classes
- Config
- def orElse[A1 >: A](that: => Config[A1]): Config[A1]
A named version of
||.A named version of
||.- Definition Classes
- Config
- def orElseIf(condition: (Error) => Boolean): OrElse[A]
Returns configuration which reads from this configuration, but which falls back to the specified configuration if reading from this configuration fails with an error satisfying the specified predicate.
Returns configuration which reads from this configuration, but which falls back to the specified configuration if reading from this configuration fails with an error satisfying the specified predicate.
- Definition Classes
- Config
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def repeat: Config[Chunk[A]]
Returns a new config that describes a sequence of values, each of which has the structure of this config.
Returns a new config that describes a sequence of values, each of which has the structure of this config.
- Definition Classes
- Config
- def switch[A1 >: A, B](f: (A1, Config[B])*): Config[B]
Returns a new configuration which reads from this configuration and uses the resulting value to determine the configuration to read from.
Returns a new configuration which reads from this configuration and uses the resulting value to determine the configuration to read from.
- Definition Classes
- Config
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def validate(message: => String)(f: (A) => Boolean): Config[A]
Returns a new config that describes the same structure as this one, but which performs validation during loading.
Returns a new config that describes the same structure as this one, but which performs validation during loading.
- Definition Classes
- Config
- def validateWith[B](message: => String)(pf: PartialFunction[A, B]): Config[B]
Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified partial function, failing with the specified validation error if the partial function is not defined.
Returns a new config whose structure is the same as this one, but which may produce a different Scala value, constructed using the specified partial function, failing with the specified validation error if the partial function is not defined.
- Definition Classes
- Config
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withDefault[A1 >: A](default: => A1): Config[A1]
Returns a new config that describes the same structure as this one, but has the specified default value in case the information cannot be found.
Returns a new config that describes the same structure as this one, but has the specified default value in case the information cannot be found.
- Definition Classes
- Config
- def zip[B](that: => Config[B])(implicit z: Zippable[A, B]): Config[Out]
A named version of
++.A named version of
++.- Definition Classes
- Config
- def zipWith[B, C](that: => Config[B])(f: (A, B) => C): Config[C]
Returns a new configuration that is the composition of this configuration and the specified configuration, combining their values using the function
f.Returns a new configuration that is the composition of this configuration and the specified configuration, combining their values using the function
f.- Definition Classes
- Config
- def ||[A1 >: A](that: => Config[A1]): Config[A1]
Returns a config whose structure is preferentially described by this config, but which falls back to the specified config if there is an issue reading from this config.
Returns a config whose structure is preferentially described by this config, but which falls back to the specified config if there is an issue reading from this config.
- Definition Classes
- Config