t

enumeratum

PlayUppercaseEnum

trait PlayUppercaseEnum[A <: EnumEntry] extends Enum[A] with PlayUppercaseJsonEnum[A] with PlayUppercasePathBindableEnum[A] with PlayUppercaseQueryBindableEnum[A] with PlayUppercaseFormFieldEnum[A]

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

Note, the binders created here transform to upper case.

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)
Linear Supertypes
PlayUppercaseFormFieldEnum[A], PlayUppercaseQueryBindableEnum[A], PlayUppercasePathBindableEnum[A], PlayUppercaseJsonEnum[A], Enum[A], EnumCompat[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayUppercaseEnum
  2. PlayUppercaseFormFieldEnum
  3. PlayUppercaseQueryBindableEnum
  4. PlayUppercasePathBindableEnum
  5. PlayUppercaseJsonEnum
  6. Enum
  7. EnumCompat
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def values: IndexedSeq[A]
    Definition Classes
    EnumCompat

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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. implicit def contraJsonWrites[B <: A]: Writes[B]
    Definition Classes
    PlayUppercaseJsonEnum
  7. implicit def contraKeyWrites[K <: A]: KeyWrites[K]
    Definition Classes
    PlayUppercaseJsonEnum
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def extraNamesToValuesMap: Map[String, A]
    Definition Classes
    Enum
  11. macro def findValues: IndexedSeq[A]
    Attributes
    protected
    Definition Classes
    EnumCompat
  12. val formField: Mapping[A]

    Form field for this enum

    Form field for this enum

    Definition Classes
    PlayUppercaseFormFieldEnum
  13. lazy val fromPath: PathBindableExtractor[A]

    Binder for play.api.routing.sird router

    Binder for play.api.routing.sird router

    Definition Classes
    PlayUppercasePathBindableEnum
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def indexOf(member: A): Int
    Definition Classes
    Enum
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. implicit val jsonFormat: Format[A]
    Definition Classes
    PlayUppercaseJsonEnum
  19. implicit val keyReads: KeyReads[A]
    Definition Classes
    PlayUppercaseJsonEnum
  20. implicit val keyWrites: KeyWrites[A]
    Definition Classes
    PlayUppercaseJsonEnum
  21. final lazy val lowerCaseNamesToValuesMap: Map[String, A]
    Definition Classes
    Enum
  22. lazy val namesToValuesMap: Map[String, A]
    Definition Classes
    Enum
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. implicit val pathBindable: PathBindable[A]

    Implicit path binder for Play's default router

    Implicit path binder for Play's default router

    Definition Classes
    PlayUppercasePathBindableEnum
  27. implicit val queryBindable: QueryStringBindable[A]
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final lazy val upperCaseNameValuesToMap: Map[String, A]
    Definition Classes
    Enum
  31. final lazy val valuesToIndex: Map[A, Int]
    Definition Classes
    Enum
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withName(name: String): A
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  36. def withNameEither(name: String): Either[NoSuchMember[A], A]
    Definition Classes
    Enum
  37. def withNameInsensitive(name: String): A
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  38. def withNameInsensitiveEither(name: String): Either[NoSuchMember[A], A]
    Definition Classes
    Enum
  39. def withNameInsensitiveOption(name: String): Option[A]
    Definition Classes
    Enum
  40. def withNameLowercaseOnly(name: String): A
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  41. def withNameLowercaseOnlyEither(name: String): Either[NoSuchMember[A], A]
    Definition Classes
    Enum
  42. def withNameLowercaseOnlyOption(name: String): Option[A]
    Definition Classes
    Enum
  43. def withNameOption(name: String): Option[A]
    Definition Classes
    Enum
  44. def withNameUppercaseOnly(name: String): A
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  45. def withNameUppercaseOnlyEither(name: String): Either[NoSuchMember[A], A]
    Definition Classes
    Enum
  46. def withNameUppercaseOnlyOption(name: String): Option[A]
    Definition Classes
    Enum

Deprecated Value Members

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

Inherited from PlayUppercaseFormFieldEnum[A]

Inherited from PlayUppercaseQueryBindableEnum[A]

Inherited from PlayUppercasePathBindableEnum[A]

Inherited from PlayUppercaseJsonEnum[A]

Inherited from Enum[A]

Inherited from EnumCompat[A]

Inherited from AnyRef

Inherited from Any

Ungrouped