enumeratum.values

ArgonautValueEnum

sealed trait ArgonautValueEnum[ValueType, EntryType <: ValueEnumEntry[ValueType]] extends AnyRef

Base trait for Value-based Enumeratum Enums that automatically adds Argonaut Json Encoders and Decoders.

Example

scala> import enumeratum.values._
scala> import argonaut._
scala> import Argonaut._

scala> sealed abstract class TrafficLight(val value: Int) extends IntEnumEntry
scala> case object TrafficLight
     |     extends IntEnum[TrafficLight]
     |       with IntArgonautEnum[TrafficLight] {
     |   case object Red    extends TrafficLight(1)
     |   case object Yellow extends TrafficLight(2)
     |   case object Green  extends TrafficLight(3)
     |   val values = findValues
     | }

scala> val light: TrafficLight = TrafficLight.Red
scala> light.asJson
res0: Json = 1

scala> Json.jNumber(1).as[TrafficLight]
res1: DecodeResult[TrafficLight] = DecodeResult(Right(Red))

scala> Json.jNumber(5).as[TrafficLight]
res1: DecodeResult[TrafficLight] = DecodeResult(Left((5 is not a member of enum TrafficLight,CursorHistory(List()))))
ValueType
EntryType

Self Type
ArgonautValueEnum[ValueType, EntryType] with ValueEnum[ValueType, EntryType]
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ArgonautValueEnum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. implicit abstract def argonautDecoder: DecodeJson[EntryType]

  2. implicit abstract def argonautEncoder: EncodeJson[EntryType]

Concrete 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. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  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. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  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
  16. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped