pureconfig.error

UnknownKey

final case class UnknownKey(key: String, location: Option[ConfigValueLocation]) extends ConfigReaderFailure 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

Annotations
@deprecated
Deprecated

(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig

Linear Supertypes
Serializable, Serializable, Product, Equals, ConfigReaderFailure, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UnknownKey
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ConfigReaderFailure
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnknownKey(key: String, location: Option[ConfigValueLocation])

    key

    the unknown key

    location

    an optional location of the ConfigValue that raised the failure

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def description: String

    A human-readable description of the failure.

    A human-readable description of the failure.

    Definition Classes
    UnknownKey → ConfigReaderFailure

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

    Definition Classes
    AnyRef

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. val key: String

    the unknown key

  14. val location: Option[ConfigValueLocation]

    an optional location of the ConfigValue that raised the failure

    an optional location of the ConfigValue that raised the failure

    Definition Classes
    UnknownKey → ConfigReaderFailure

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def path: Some[String]

    The optional path to the ConfigValue that raised the failure.

    The optional path to the ConfigValue that raised the failure.

    Definition Classes
    UnknownKey → ConfigReaderFailure

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

    Definition Classes
    AnyRef

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    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 ConfigReaderFailure

Inherited from AnyRef

Inherited from Any

Ungrouped