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[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.CloneNotSupportedException]) @native()

6.  def enum[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Mapping[A]

   Returns an Enum mapping

   Returns an Enum mapping

   Example:

   scala> import enumeratum._
   scala> import play.api.data.Form
   
   scala> sealed trait Greeting extends EnumEntry
   
   scala> object Greeting extends Enum[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" -> Forms.enum(Greeting))
   scala> form.bind(Map("greeting" -> "Hello")).value
   res0: Option[Greeting] = Some(Hello)
   
   scala> val formInsensitive = Form("greeting" -> Forms.enum(Greeting, true))
   scala> formInsensitive.bind(Map("greeting" -> "hElLo")).value
   res1: Option[Greeting] = Some(Hello)

   enum

   The enum

   insensitive

   bind in a case-insensitive way, defaults to false

7.  def enumLowerCaseOnly[A <: EnumEntry](enum: Enum[A]): Mapping[A]

   Returns an Enum mapping for lower case binding only

   Returns an Enum mapping for lower case binding only

   Example:

   scala> import enumeratum._
   scala> import play.api.data.Form
   
   scala> sealed trait Greeting extends EnumEntry
   
   scala> object Greeting extends Enum[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" -> Forms.enumLowerCaseOnly(Greeting))
   scala> form.bind(Map("greeting" -> "hello")).value
   res0: Option[Greeting] = Some(Hello)
   
   scala> form.bind(Map("greeting" -> "Hello")).value
   res1: Option[Greeting] = None

   enum

   The enum

8.  def enumUppercaseOnly[A <: EnumEntry](enum: Enum[A]): Mapping[A]

   Returns an Enum mapping for upper case binding only

   Returns an Enum mapping for upper case binding only

   Example:

   scala> import enumeratum._
   scala> import play.api.data.Form
   
   scala> sealed trait Greeting extends EnumEntry
   
   scala> object Greeting extends Enum[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" -> Forms.enumUppercaseOnly(Greeting))
   scala> form.bind(Map("greeting" -> "HELLO")).value
   res0: Option[Greeting] = Some(Hello)
   
   scala> form.bind(Map("greeting" -> "Hello")).value
   res1: Option[Greeting] = None

   enum

   The enum

9.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

10.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

11.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

12.  def format[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Formatter[A]

    Returns a Formatter for Enum

    Returns a Formatter for Enum

    enum

    The enum

    insensitive

    bind in a case-insensitive way, defaults to false

13.  def formatLowercaseOnly[A <: EnumEntry](enum: Enum[A]): Formatter[A]

    Returns a Formatter for Enum that transforms to lower case

    Returns a Formatter for Enum that transforms to lower case

    enum

    The enum

14.  def formatUppercaseOnly[A <: EnumEntry](enum: Enum[A]): Formatter[A]

    Returns a Formatter for Enum that transforms to upper case

    Returns a Formatter for Enum that transforms to upper case

    enum

    The enum

15.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

16.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

17.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

18.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

19.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

20.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

21.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

22.  def toString(): String

    Definition Classes

    AnyRef → Any

23.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

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

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

25.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()