enumeratum-play
API
Generated with
enumeratum-play/enumeratum/Forms

Forms

enumeratum.Forms$
object Forms

Created by Lloyd on 2/3/15.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Forms.type

Members list

Value members

Concrete methods

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

Value parameters

e

The enum

Attributes

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

Value parameters

e

The enum

Attributes

def format[A <: EnumEntry](e: Enum[A], insensitive: Boolean): Formatter[A]

Returns a Formatter for Enum

Returns a Formatter for Enum

Value parameters

e

The enum

insensitive

bind in a case-insensitive way, defaults to false

Attributes

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

Value parameters

e

The enum

Attributes

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

Value parameters

e

The enum

Attributes

Inherited methods

def enumMapping[A <: EnumEntry](e: Enum[A], insensitive: Boolean): 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)

Value parameters

e

The enum

insensitive

bind in a case-insensitive way, defaults to false

Attributes

Inherited from:
FormsCompat (hidden)
Generated with