Packages

class FieldCoproductHint[A] extends CoproductHint[A]

Hint where the options are disambiguated by a key = "value" field inside the config.

This hint will cause derived ConfigConvert instance to fail to convert configs to objects if the object has a field with the same name as the disambiguation key.

By default, the field value written is the class or coproduct option name converted to kebab case. This mapping can be changed by overriding the method fieldValue of this class.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldCoproductHint
  2. CoproductHint
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FieldCoproductHint(key: String)

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fieldValue(name: String): String

    Returns the field value for a class or coproduct option name.

    Returns the field value for a class or coproduct option name.

    name

    the name of the class or coproduct option

    returns

    the field value associated with the given class or coproduct option name.

    Attributes
    protected
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def from(cursor: ConfigCursor, options: Seq[String]): Result[Action]

    Given a ConfigCursor for the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options.

    Given a ConfigCursor for the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options. This method can decide either to:

    This method can return a Left if the hint fails to produce a valid CoproductHint.Action.

    cursor

    a ConfigCursor at the sealed family option

    options

    the names of the coproduct options for the given type

    returns

    a ConfigReader.Result of CoproductHint.Action as defined above.

    Definition Classes
    FieldCoproductHintCoproductHint
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def to(value: ConfigValue, name: String): ConfigValue

    Given the ConfigValue for a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.

    Given the ConfigValue for a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.

    value

    the ConfigValue of the class or coproduct option

    name

    the name of the class or coproduct option

    returns

    the config for the sealed family or coproduct wrapped in a Right, or a Left with the failure if some error occurred.

    Definition Classes
    FieldCoproductHintCoproductHint
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from CoproductHint[A]

Inherited from AnyRef

Inherited from Any

Ungrouped