Class

pureconfig.error

UnknownKey

Related Doc: package error

Permalink

final case class UnknownKey(key: String, location: Option[ConfigValueLocation]) extends ConvertFailure with Product with Serializable

A failure representing the presence of an unknown key in a ConfigObject. This error is raised when a key of a ConfigObject is not mapped into a field of a given type, and the allowUnknownKeys property of the ProductHint for the type in question is false.

key

the unknown key

location

an optional location of the ConfigValue that raised the failure

Linear Supertypes
Serializable, Serializable, Product, Equals, ConvertFailure, ConfigReaderFailure, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnknownKey
  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 UnknownKey(key: String, location: Option[ConfigValueLocation])

    Permalink

    key

    the unknown key

    location

    an optional location of the ConfigValue that raised the failure

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. def description: String

    Permalink

    A human-readable description of the failure.

    A human-readable description of the failure.

    Definition Classes
    UnknownKey → ConfigReaderFailure

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. val key: String

    Permalink

    the unknown key

  12. 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
    UnknownKey → ConfigReaderFailure

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def path: String

    Permalink

    The path to the ConfigValue that raised the failure.

    The path to the ConfigValue that raised the failure.

    Definition Classes
    UnknownKey → ConvertFailure

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

    Permalink
    Definition Classes
    AnyRef

  18. final def wait(): Unit

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

  19. final def wait(arg0: Long, arg1: Int): Unit

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

  20. final def wait(arg0: Long): Unit

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

  21. def withImprovedContext(parentKey: String, parentLocation: Option[ConfigValueLocation]): UnknownKey

    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
    UnknownKey → ConfigReaderFailure

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