QueryStringBindable

Binder for query string parameters.

You can provide an implementation of QueryStringBindable[A] for any type A you want to be able to bind directly from the request query string.

For example, if you have the following type to encode pagination:

/**
* @param index Current page index
* @param size Number of items in a page
*/ *   case class Pager(index: Int, size: Int)

Play will create a Pager(5, 42) value from a query string looking like /foo?p.index=5&p.size=42 if you define an instance of QueryStringBindable[Pager] available in the implicit scope.

For example:

object Pager {
implicit def queryStringBinder(implicit intBinder: QueryStringBindable[Int]) = new QueryStringBindable[Pager] {
  override def bind(key: String, params: Map[String, Seq[String]]): Option[Either[String, Pager]] = {
    for {
      index <- intBinder.bind(key + ".index", params)
      size <- intBinder.bind(key + ".size", params)
    } yield {
      (index, size) match {
        case (Right(index), Right(size)) => Right(Pager(index, size))
        case _ => Left("Unable to bind a Pager")
      }
    }
  }
  override def unbind(key: String, pager: Pager): String = {
    intBinder.unbind(key + ".index", pager.index) + "&" + intBinder.unbind(key + ".size", pager.size)
  }
}
}

To use it in a route, just write a type annotation aside the parameter you want to bind:

GET  /foo        controllers.foo(p: Pager)

Self Type: QueryStringBindable[A]
Annotations: @implicitNotFound( ... )
Source: Binders.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

Parsing, bindableBoolean, bindableDouble, bindableFloat, bindableInt, bindableLong, bindableUUID

Abstract Value Members

abstract def bind(key: String, params: Map[String, Seq[String]]): Option[Either[String, A]]

Bind a query string parameter.
Bind a query string parameter.
key
Parameter key
params
QueryString data
returns
None if the parameter was not present in the query string data. Otherwise, returns Some of either Right of the parameter value, or Left of an error message if the binding failed.
abstract def unbind(key: String, value: A): String

Unbind a query string parameter.
Unbind a query string parameter.
key
Parameter key
value
Parameter value.
returns
a query string fragment containing the key and its value. E.g. "foo=42"

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def javascriptUnbind: String

Javascript function to unbind in the Javascript router.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transform[B](toB: (A) ⇒ B, toA: (B) ⇒ A): QueryStringBindable[B]

Transform this QueryStringBindable[A] to QueryStringBindable[B]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait QueryStringBindable[A] extends AnyRef

Abstract Value Members

abstract def bind(key: String, params: Map[String, Seq[String]]): Option[Either[String, A]]

abstract def unbind(key: String, value: A): String

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def javascriptUnbind: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def transform[B](toB: (A) ⇒ B, toA: (B) ⇒ A): QueryStringBindable[B]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped