t

enumeratum.values

ShortPlayEnum

trait ShortPlayEnum[EnumEntry <: ShortEnumEntry] extends ShortEnum[EnumEntry] with ShortPlayPathBindableValueEnum[EnumEntry] with ShortPlayQueryBindableValueEnum[EnumEntry] with ShortPlayFormValueEnum[EnumEntry] with ShortPlayJsonValueEnum[EnumEntry]

A ShortEnum 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

See IntPlayEnum for example usage.

Linear Supertypes
ShortPlayJsonValueEnum[EnumEntry], PlayJsonValueEnum[Short, EnumEntry], ShortPlayFormValueEnum[EnumEntry], PlayFormValueEnum[Short, EnumEntry], ShortPlayQueryBindableValueEnum[EnumEntry], PlayQueryBindableValueEnum[Short, EnumEntry], ShortPlayPathBindableValueEnum[EnumEntry], PlayPathBindableValueEnum[Short, EnumEntry], ShortEnum[EnumEntry], ShortEnumCompat[EnumEntry], ValueEnum[Short, EnumEntry], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShortPlayEnum
  2. ShortPlayJsonValueEnum
  3. PlayJsonValueEnum
  4. ShortPlayFormValueEnum
  5. PlayFormValueEnum
  6. ShortPlayQueryBindableValueEnum
  7. PlayQueryBindableValueEnum
  8. ShortPlayPathBindableValueEnum
  9. PlayPathBindableValueEnum
  10. ShortEnum
  11. ShortEnumCompat
  12. ValueEnum
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def values: IndexedSeq[EnumEntry]
    Definition Classes
    ValueEnum

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val baseFormatter: Formatter[Short]

    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
    ShortPlayFormValueEnum → PlayFormValueEnum
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. macro def findValues: IndexedSeq[EnumEntry]
    Attributes
    protected
    Definition Classes
    ShortEnumCompat
  10. lazy val formField: Mapping[EnumEntry]

    Field for mapping this enum in Forms

    Field for mapping this enum in Forms

    Definition Classes
    PlayFormValueEnum
  11. implicit val format: Format[EnumEntry]
    Definition Classes
    ShortPlayJsonValueEnum → PlayJsonValueEnum
  12. lazy val fromPath: PathBindableExtractor[EnumEntry]

    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> 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
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. implicit val pathBindable: PathBindable[EnumEntry]

    Implicit path binder for Play's default router

    Implicit path binder for Play's default router

    Definition Classes
    ShortPlayPathBindableValueEnum → PlayPathBindableValueEnum
  20. implicit val queryBindable: QueryStringBindable[EnumEntry]

    Implicit path binder for Play's default router

    Implicit path binder for Play's default router

    Definition Classes
    ShortPlayQueryBindableValueEnum → PlayQueryBindableValueEnum
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final lazy val valuesToEntriesMap: Map[Short, EnumEntry]
    Definition Classes
    ValueEnum
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def withValue(i: Short): EnumEntry
    Definition Classes
    ValueEnum
    Annotations
    @SuppressWarnings()
  28. def withValueEither(i: Short): Either[NoSuchMember[Short, ValueEnumEntry[Short]], EnumEntry]
    Definition Classes
    ValueEnum
  29. def withValueOpt(i: Short): Option[EnumEntry]
    Definition Classes
    ValueEnum

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from ShortPlayJsonValueEnum[EnumEntry]

Inherited from PlayJsonValueEnum[Short, EnumEntry]

Inherited from ShortPlayFormValueEnum[EnumEntry]

Inherited from PlayFormValueEnum[Short, EnumEntry]

Inherited from ShortPlayQueryBindableValueEnum[EnumEntry]

Inherited from PlayQueryBindableValueEnum[Short, EnumEntry]

Inherited from ShortPlayPathBindableValueEnum[EnumEntry]

Inherited from PlayPathBindableValueEnum[Short, EnumEntry]

Inherited from ShortEnum[EnumEntry]

Inherited from ShortEnumCompat[EnumEntry]

Inherited from ValueEnum[Short, EnumEntry]

Inherited from AnyRef

Inherited from Any

Ungrouped