c

pureconfig.generic

EnumCoproductHint

class EnumCoproductHint[A] extends CoproductHint[A]

Hint applicable to sealed families of case objects where objects are written and read as strings with their type names. Trying to read or write values that are not case objects results in failure.

A

the type of the coproduct or sealed family for which this hint applies

Annotations
@deprecated
Deprecated

(Since version 0.11.0) Use pureconfig.generic.semiauto.deriveEnumerationReader[A], pureconfig.generic.semiauto.deriveEnumerationWriter[A] and pureconfig.generic.semiauto.deriveEnumerationConvert[A] instead

Linear Supertypes
CoproductHint[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnumCoproductHint
  2. CoproductHint
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EnumCoproductHint()

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]
    Definition Classes
    EnumCoproductHint → CoproductHint
  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
    Definition Classes
    EnumCoproductHint → CoproductHint
  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