IntPlayEnum

An IntEnum that has a lot of the Play-related implicits built-in so you can avoid boilerplate.

Things included are:

implicit PathBindable (for binding from request path)
implicit QueryStringBindable (for binding from query strings)
formField for doing things like Form("hello" -> MyEnum.formField)
implicit Json format

Example:

scala> import enumeratum.values._
scala> import play.api.data.Form
scala> import play.api.libs.json._

scala> sealed abstract class Greeting(val value:Int) extends IntEnumEntry

scala> object Greeting extends IntPlayEnum[Greeting] {
     |   val values = findValues
     |   case object Hello   extends Greeting(1)
     |   case object GoodBye extends Greeting(2)
     |   case object Hi      extends Greeting(3)
     |   case object Bye     extends Greeting(4)
     | }

scala> val form = Form("greeting" -> Greeting.formField)
scala> form.bind(Map("greeting" -> "1")).value
res0: Option[Greeting] = Some(Hello)

scala> Json.toJson(Greeting.Hello) res1: JsValue = 1

Linear Supertypes

IntPlayJsonValueEnum[EnumEntry], PlayJsonValueEnum[Int, EnumEntry], IntPlayFormValueEnum[EnumEntry], PlayFormValueEnum[Int, EnumEntry], IntPlayQueryBindableValueEnum[EnumEntry], PlayQueryBindableValueEnum[Int, EnumEntry], IntPlayPathBindableValueEnum[EnumEntry], PlayPathBindableValueEnum[Int, EnumEntry], IntEnum[EnumEntry], ValueEnum[Int, EnumEntry], AnyRef, Any

Abstract Value Members

abstract def values: IndexedSeq[EnumEntry]

Definition Classes
ValueEnum

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
val baseFormatter: Formatter[Int]

The Formatter for binding the ValueType of this ValueEnum.
The Formatter for binding the ValueType of this ValueEnum.
Used for building the Formatter for the entries

Attributes
protected
Definition Classes
IntPlayFormValueEnum → PlayFormValueEnum
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
macro def findValues: IndexedSeq[EnumEntry]

Attributes
protected
Definition Classes
IntEnum
lazy val formField: Mapping[EnumEntry]

Field for mapping this enum in Forms
Field for mapping this enum in Forms

Definition Classes
PlayFormValueEnum
implicit val format: Format[EnumEntry]

Definition Classes
IntPlayJsonValueEnum → PlayJsonValueEnum

lazy val fromPath: PathBindableExtractor[EnumEntry]

Binder for play.api.routing.sird router

Example:

scala> import play.api.routing.sird._
scala> import play.api.routing._
scala> import play.api.mvc._

scala> sealed abstract class Greeting(val value: Int) extends IntEnumEntry

scala> object Greeting extends IntPlayEnum[Greeting] {
     |   val values = findValues
     |   case object Hello   extends Greeting(1)
     |   case object GoodBye extends Greeting(2)
     |   case object Hi      extends Greeting(3)
     |   case object Bye     extends Greeting(4)
     | }

scala> val router = Router.from {
     |   case GET(p"/hello/${Greeting.fromPath(greeting)}") => Action {
     |     Results.Ok(s"$greeting")
     |   }
     | }
scala> router.routes
res0: Router.Routes = <function1>

Definition Classes: PlayPathBindableValueEnum

final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit val pathBindable: PathBindable[EnumEntry]

Implicit path binder for Play's default router
Implicit path binder for Play's default router

Definition Classes
IntPlayPathBindableValueEnum → PlayPathBindableValueEnum
implicit val queryBindable: QueryStringBindable[EnumEntry]

Implicit path binder for Play's default router
Implicit path binder for Play's default router

Definition Classes
IntPlayQueryBindableValueEnum → PlayQueryBindableValueEnum
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final lazy val valuesToEntriesMap: Map[Int, EnumEntry]

Definition Classes
ValueEnum
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withValue(i: Int): EnumEntry

Definition Classes
ValueEnum
Annotations
@SuppressWarnings()
def withValueOpt(i: Int): Option[EnumEntry]

Definition Classes
ValueEnum

Related Doc: package values

trait IntPlayEnum[EnumEntry <: IntEnumEntry] extends IntEnum[EnumEntry] with IntPlayPathBindableValueEnum[EnumEntry] with IntPlayQueryBindableValueEnum[EnumEntry] with IntPlayFormValueEnum[EnumEntry] with IntPlayJsonValueEnum[EnumEntry]

Abstract Value Members

abstract def values: IndexedSeq[EnumEntry]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val baseFormatter: Formatter[Int]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

macro def findValues: IndexedSeq[EnumEntry]

lazy val formField: Mapping[EnumEntry]

implicit val format: Format[EnumEntry]

lazy val fromPath: PathBindableExtractor[EnumEntry]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val pathBindable: PathBindable[EnumEntry]

implicit val queryBindable: QueryStringBindable[EnumEntry]

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

def toString(): String

final lazy val valuesToEntriesMap: Map[Int, EnumEntry]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withValue(i: Int): EnumEntry

def withValueOpt(i: Int): Option[EnumEntry]

Inherited from IntPlayJsonValueEnum[EnumEntry]

Inherited from PlayJsonValueEnum[Int, EnumEntry]

Inherited from IntPlayFormValueEnum[EnumEntry]

Inherited from PlayFormValueEnum[Int, EnumEntry]

Inherited from IntPlayQueryBindableValueEnum[EnumEntry]

Inherited from PlayQueryBindableValueEnum[Int, EnumEntry]

Inherited from IntPlayPathBindableValueEnum[EnumEntry]

Inherited from PlayPathBindableValueEnum[Int, EnumEntry]

Inherited from IntEnum[EnumEntry]

Inherited from ValueEnum[Int, EnumEntry]

Inherited from AnyRef

Inherited from Any

Ungrouped