trait PlayEnum[A <: EnumEntry] extends Enum[A] with PlayJsonEnum[A] with PlayPathBindableEnum[A] with PlayQueryBindableEnum[A] with PlayFormFieldEnum[A]
An Enum that has a lot of the Play-related implicits built-in so you can avoid boilerplate.
Note, the binders created here are case-sensitive.
Things included are:
- implicit JSON format
- implicit PathBindable (for binding from request path)
- implicit QueryStringBindable (for binding from query strings)
- formField for doing things like
Form("hello" -> MyEnum.formField)
Example:
scala> import enumeratum._ scala> import play.api.data.Form scala> import play.api.libs.json._ scala> sealed trait Greeting extends EnumEntry scala> object Greeting extends PlayEnum[Greeting] { | val values = findValues | case object Hello extends Greeting | case object GoodBye extends Greeting | case object Hi extends Greeting | case object Bye extends Greeting | } scala> val form = Form("greeting" -> Greeting.formField) scala> form.bind(Map("greeting" -> "Hello")).value res0: Option[Greeting] = Some(Hello)
scala> Json.toJson(Greeting.Hello) res1: JsValue = "Hello"
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- PlayEnum
- PlayFormFieldEnum
- PlayQueryBindableEnum
- PlayPathBindableEnum
- PlayJsonEnum
- Enum
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Abstract Value Members
-
abstract
def
values: IndexedSeq[A]
- Definition Classes
- Enum
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
implicit
def
contraJsonWrites[B <: A]: Writes[B]
- Definition Classes
- PlayJsonEnum
-
implicit
def
contraKeyWrites[K <: A]: KeyWrites[K]
- Definition Classes
- PlayJsonEnum
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
extraNamesToValuesMap: Map[String, A]
- Definition Classes
- Enum
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
macro
def
findValues: IndexedSeq[A]
- Attributes
- protected
- Definition Classes
- Enum
-
val
formField: Mapping[A]
Form field for this enum
Form field for this enum
- Definition Classes
- PlayFormFieldEnum
-
lazy val
fromPath: PathBindableExtractor[A]
Binder for play.api.routing.sird router
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> import enumeratum._ scala> sealed trait Greeting extends EnumEntry scala> object Greeting extends PlayEnum[Greeting] { | val values = findValues | case object Hello extends Greeting | case object GoodBye extends Greeting | case object Hi extends Greeting | case object Bye extends Greeting | } 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
- PlayPathBindableEnum
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
indexOf(member: A): Int
- Definition Classes
- Enum
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
implicit
val
jsonFormat: Format[A]
- Definition Classes
- PlayJsonEnum
-
implicit
val
keyReads: KeyReads[A]
- Definition Classes
- PlayJsonEnum
-
implicit
val
keyWrites: KeyWrites[A]
- Definition Classes
- PlayJsonEnum
-
final
lazy val
lowerCaseNamesToValuesMap: Map[String, A]
- Definition Classes
- Enum
-
lazy val
namesToValuesMap: Map[String, A]
- Definition Classes
- Enum
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
implicit
val
pathBindable: PathBindable[A]
Implicit path binder for Play's default router
Implicit path binder for Play's default router
- Definition Classes
- PlayPathBindableEnum
-
implicit
val
queryBindable: QueryStringBindable[A]
- Definition Classes
- PlayQueryBindableEnum
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
lazy val
upperCaseNameValuesToMap: Map[String, A]
- Definition Classes
- Enum
-
final
lazy val
valuesToIndex: Map[A, Int]
- Definition Classes
- Enum
-
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( ... ) @native()
-
def
withName(name: String): A
- Definition Classes
- Enum
- Annotations
- @SuppressWarnings()
-
def
withNameEither(name: String): Either[NoSuchMember[A], A]
- Definition Classes
- Enum
-
def
withNameInsensitive(name: String): A
- Definition Classes
- Enum
- Annotations
- @SuppressWarnings()
-
def
withNameInsensitiveEither(name: String): Either[NoSuchMember[A], A]
- Definition Classes
- Enum
-
def
withNameInsensitiveOption(name: String): Option[A]
- Definition Classes
- Enum
-
def
withNameLowercaseOnly(name: String): A
- Definition Classes
- Enum
- Annotations
- @SuppressWarnings()
-
def
withNameLowercaseOnlyEither(name: String): Either[NoSuchMember[A], A]
- Definition Classes
- Enum
-
def
withNameLowercaseOnlyOption(name: String): Option[A]
- Definition Classes
- Enum
-
def
withNameOption(name: String): Option[A]
- Definition Classes
- Enum
-
def
withNameUppercaseOnly(name: String): A
- Definition Classes
- Enum
- Annotations
- @SuppressWarnings()
-
def
withNameUppercaseOnlyEither(name: String): Either[NoSuchMember[A], A]
- Definition Classes
- Enum
-
def
withNameUppercaseOnlyOption(name: String): Option[A]
- Definition Classes
- Enum