enumeratum.values

IntCirceEnum

trait IntCirceEnum[EntryType <: IntEnumEntry] extends CirceValueEnum[Int, EntryType]

CirceEnum for IntEnumEntry

scala> import enumeratum.values._
scala> import cats.syntax.either._
scala> import io.circe._
scala> import io.circe.syntax._

scala> sealed abstract class ShirtSize(val value:Int) extends IntEnumEntry
scala> case object ShirtSize extends IntEnum[ShirtSize] with IntCirceEnum[ShirtSize] {
     |  case object Small  extends ShirtSize(1)
     |  case object Medium extends ShirtSize(2)
     |  case object Large  extends ShirtSize(3)
     |  val values = findValues
     | }

scala> val size: ShirtSize = ShirtSize.Small

scala> size.asJson
res0: Json = 1

scala> Json.fromInt(3).as[ShirtSize]
res1: Decoder.Result[ShirtSize] = Right(Large)

scala> Json.fromInt(10).as[ShirtSize]
res2: Decoder.Result[ShirtSize] = Left(DecodingFailure(10 is not a member of enum ShirtSize, List()))
Self Type
IntCirceEnum[EntryType] with ValueEnum[Int, EntryType]
Linear Supertypes
CirceValueEnum[Int, EntryType], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IntCirceEnum
  2. CirceValueEnum
  3. AnyRef
  4. 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. implicit val circeDecoder: Decoder[EntryType]

    Implicit Decoder for this enum

    Implicit Decoder for this enum

    Definition Classes
    IntCirceEnumCirceValueEnum
  8. implicit val circeEncoder: Encoder[EntryType]

    Implicit Encoder for this enum

    Implicit Encoder for this enum

    Definition Classes
    IntCirceEnumCirceValueEnum
  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 CirceValueEnum[Int, EntryType]

Inherited from AnyRef

Inherited from Any

Ungrouped