Class

pureconfig.error

KeyNotFound

Related Doc: package error

Permalink

final case class KeyNotFound(key: String, location: Option[ConfigValueLocation], candidates: Set[String] = Set()) extends ConvertFailure with Product with Serializable

A failure representing a key missing from a ConfigObject.

key

the key that is missing

location

an optional location of the ConfigValue that raised the failure

candidates

a set of candidate keys that might correspond to the desired key in case of a misconfigured ProductHint

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyNotFound
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ConvertFailure
  7. ConfigReaderFailure
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KeyNotFound(key: String, location: Option[ConfigValueLocation], candidates: Set[String] = Set())

    Permalink

    key

    the key that is missing

    location

    an optional location of the ConfigValue that raised the failure

    candidates

    a set of candidate keys that might correspond to the desired key in case of a misconfigured ProductHint

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. val candidates: Set[String]

    Permalink

    a set of candidate keys that might correspond to the desired key in case of a misconfigured ProductHint

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def description: String

    Permalink

    A human-readable description of the failure.

    A human-readable description of the failure.

    Definition Classes
    KeyNotFoundConfigReaderFailure
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  12. val key: String

    Permalink

    the key that is missing

  13. val location: Option[ConfigValueLocation]

    Permalink

    an optional location of the ConfigValue that raised the failure

    an optional location of the ConfigValue that raised the failure

    Definition Classes
    KeyNotFoundConfigReaderFailure
  14. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  17. def path: String

    Permalink

    The path to the ConfigValue that raised the failure.

    The path to the ConfigValue that raised the failure.

    Definition Classes
    KeyNotFoundConvertFailure
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def withImprovedContext(parentKey: String, parentLocation: Option[ConfigValueLocation]): KeyNotFound

    Permalink

    Improves the context of this failure with the key to the parent node and its optional location.

    Improves the context of this failure with the key to the parent node and its optional location.

    Definition Classes
    KeyNotFoundConfigReaderFailure

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ConvertFailure

Inherited from ConfigReaderFailure

Inherited from AnyRef

Inherited from Any

Ungrouped