enumeratum

ArgonautEnum

trait ArgonautEnum[A <: EnumEntry] extends AnyRef

Trait that automatically adds Argonaut Json Encoders and Decoders typeclasses to your Enumeratum enums.

Example:

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

scala> sealed trait TrafficLight extends EnumEntry
scala> case object TrafficLight extends Enum[TrafficLight] with ArgonautEnum[TrafficLight] {
     |   case object Red    extends TrafficLight
     |   case object Yellow extends TrafficLight
     |   case object Green  extends TrafficLight
     |   val values = findValues
     | }

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

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

scala> Json.jString("Purple").as[TrafficLight]
res1: DecodeResult[TrafficLight] = DecodeResult(Left((Purple' is not a member of enum TrafficLight,CursorHistory(List()))))
A

Self Type
ArgonautEnum[A] with Enum[A]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ArgonautEnum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. implicit val argonautDecoder: DecodeJson[A]

  7. implicit val argonautEncoder: EncodeJson[A]

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped