Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package routing
    Definition Classes
    api
  • package sird

    The Play "String Interpolating Routing DSL", sird for short.

    The Play "String Interpolating Routing DSL", sird for short.

    This provides: - Extractors for requests that extract requests by method, eg GET, POST etc. - A string interpolating path extractor - Extractors for binding parameters from paths to various types, eg int, long, double, bool.

    The request method extractors return the original request for further extraction.

    The path extractor supports three kinds of extracted values: - Path segment values. This is the default, eg p"/foo/$id". The value will be URI decoded, and may not traverse /'s. - Full path values. This can be indicated by post fixing the value with a *, eg p"/assets/$path*". The value will not be URI decoded, as that will make it impossible to distinguish between / and %2F. - Regex values. This can be indicated by post fixing the value with a regular expression enclosed in angle brackets. For example, p"/foo/$id<[0-9]+>. The value will not be URI decoded.

    The extractors for primitive types are merely provided for convenience, for example, p"/foo/${int(id)}" will extract id as an integer. If id is not an integer, the match will simply fail.

    Example usage:

    import play.api.routing.sird._
import play.api.routing._
import play.api.mvc._

Router.from {
  case GET(p"/hello/$to") => Action {
    Results.Ok(s"Hello $to")
  }
  case PUT(p"/api/items/${int(id)}") => Action.async { req =>
    Items.save(id, req.body.json.as[Item]).map { _ =>
      Results.Ok(s"Saved item $id")
    }
  }
}
    Definition Classes
    routing
  • &
  • OptionalQueryStringParameter
  • PathBindableExtractor
  • PathBindableExtractors
  • PathExtractor
  • QueryStringParameterExtractor
  • RequestMethodExtractor
  • RequestMethodExtractors
  • RequiredQueryStringParameter
  • SeqQueryStringParameter
  • UrlContext
c

play.api.routing.sird

UrlContext

implicit class UrlContext extends AnyRef

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UrlContext
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UrlContext(sc: StringContext)

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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. val p: PathExtractor

    String interpolator for extracting parameters out of URL paths.

    String interpolator for extracting parameters out of URL paths.

    By default, any sub value extracted out by the interpolator will match a path segment, that is, any String not containing a /, and its value will be decoded. If however the sub value is suffixed with *, then it will match any part of a path, and not be decoded. Regular expressions are also supported, by suffixing the sub value with a regular expression in angled brackets, and these are not decoded.

  16. macro def q: RequiredQueryStringParameter

    String interpolator for required query parameters out of query strings.

    String interpolator for required query parameters out of query strings.

    The format must match q"paramName=${param}".

  17. macro def q_*: SeqQueryStringParameter

    String interpolator for multi valued query parameters out of query strings.

    String interpolator for multi valued query parameters out of query strings.

    The format must match q_*"paramName=${params}".

  18. macro def q_?: OptionalQueryStringParameter

    String interpolator for optional query parameters out of query strings.

    String interpolator for optional query parameters out of query strings.

    The format must match q_?"paramName=${param}".

  19. macro def q_o: OptionalQueryStringParameter

    String interpolator for optional query parameters out of query strings.

    String interpolator for optional query parameters out of query strings.

    The format must match qo"paramName=${param}".

    The q_? interpolator is preferred, however Scala 2.10 does not support operator characters in String interpolator methods.

  20. macro def q_s: SeqQueryStringParameter

    String interpolator for multi valued query parameters out of query strings.

    String interpolator for multi valued query parameters out of query strings.

    The format must match qs"paramName=${params}".

    The q_* interpolator is preferred, however Scala 2.10 does not support operator characters in String interpolator methods.

  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()

Inherited from AnyRef

Inherited from Any

Ungrouped