Trait

enumeratum.values

ArgonautValueEnum

Related Doc: package values

Permalink

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()))))
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
Visibility
  1. Public
  2. All

Abstract Value Members

  1. implicit abstract def argonautDecoder: DecodeJson[EntryType]

    Permalink
  2. implicit abstract def argonautEncoder: EncodeJson[EntryType]

    Permalink

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped