object Forms extends FormsCompat

Created by Lloyd on 2/3/15.

Linear Supertypes
FormsCompat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Forms
  2. FormsCompat
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def enumLowerCaseOnly[A <: EnumEntry](e: 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
    e

    The enum

  7. def enumMapping[A <: EnumEntry](e: 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)
    e

    The enum

    insensitive

    bind in a case-insensitive way, defaults to false

    Definition Classes
    FormsCompat
    Annotations
    @inline()
  8. def enumUppercaseOnly[A <: EnumEntry](e: 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
    e

    The enum

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def format[A <: EnumEntry](e: Enum[A], insensitive: Boolean = false): Formatter[A]

    Returns a Formatter for Enum

    Returns a Formatter for Enum

    e

    The enum

    insensitive

    bind in a case-insensitive way, defaults to false

  12. def formatLowercaseOnly[A <: EnumEntry](e: Enum[A]): Formatter[A]

    Returns a Formatter for Enum that transforms to lower case

    Returns a Formatter for Enum that transforms to lower case

    e

    The enum

  13. def formatUppercaseOnly[A <: EnumEntry](e: Enum[A]): Formatter[A]

    Returns a Formatter for Enum that transforms to upper case

    Returns a Formatter for Enum that transforms to upper case

    e

    The enum

  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def enum[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Mapping[A]
    Definition Classes
    FormsCompat
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.2) Use enumMapping

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

Inherited from FormsCompat

Inherited from AnyRef

Inherited from Any

Ungrouped