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.

    Access the current Play application 
    import play.api.Play.current
    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 cache

    Contains the Cache access API.

    Contains the Cache access API.

    Definition Classes
    api
  • package controllers
    Definition Classes
    api
  • package data

    Contains data manipulation helpers (typically HTTP form handling)

    Contains data manipulation helpers (typically HTTP form handling)

    import play.api.data._
import play.api.data.Forms._

val taskForm = Form(
  tuple(
    "name" -> text(minLength = 3),
    "dueDate" -> date("yyyy-MM-dd"),
    "done" -> boolean
  )
)
    Definition Classes
    api
  • package db

    Contains the JDBC database access API.

    Contains the JDBC database access API.

    Example, retrieving a connection from the 'customers' datasource:

    val conn = db.getConnection("customers")
    Definition Classes
    api
  • package http

    Contains standard HTTP constants.

    Contains standard HTTP constants. For example:

    val text = ContentTypes.TEXT
val ok = Status.OK
val accept = HeaderNames.ACCEPT
    Definition Classes
    api
  • package i18n

    Contains the internationalisation API.

    Contains the internationalisation API.

    For example, translating a message:

    val msgString = Messages("items.found", items.size)
    Definition Classes
    api
  • package inject

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection support is built on JSR-330, which provides a specification for declaring how dependencies get wired to components. JSR-330 however does not address how components are provided to or located by a DI container. Play's API seeks to address this in a DI container agnostic way.

    The reason for providing this abstraction is so that Play, the modules it provides, and third party modules can all express their bindings in a way that is not specific to any one DI container.

    Components are bound in the DI container. Each binding is identified by a BindingKey, which is typically an interface that the component implements, and may be optionally qualified by a JSR-330 qualifier annotation. A binding key is bound to a BindingTarget, which describes how the implementation of the interface that the binding key represents is constructed or provided. Bindings may also be scoped using JSR-330 scope annotations.

    Bindings are provided by instances of Module.

    Out of the box, Play provides an implementation of this abstraction using Guice.

    Definition Classes
    api
    See also

    The Module class for information on how to provide bindings.

  • package internal
    Definition Classes
    api
  • package libs

    Contains various APIs that are useful while developing web applications.

    Contains various APIs that are useful while developing web applications.

    Definition Classes
    api
  • package mvc

    Contains the Controller/Action/Result API to handle HTTP requests.

    Contains the Controller/Action/Result API to handle HTTP requests.

    For example, a typical controller:

    class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {

  def index = Action {
    Ok("It works!")
  }

}
    Definition Classes
    api
  • package routing
    Definition Classes
    api
  • package templates
    Definition Classes
    api
  • package test

    Contains test helpers.

    Contains test helpers.

    Definition Classes
    api
  • Application
  • ApplicationLoader
  • BuiltInComponents
  • BuiltInComponentsFromContext
  • ConfigLoader
  • Configuration
  • DefaultApplication
  • DefaultMarkerContext
  • Environment
  • Logger
  • LoggerConfigurator
  • LoggerLike
  • Logging
  • LowPriorityMarkerContextImplicits
  • MarkerContext
  • MarkerContexts
  • Mode
  • NoHttpFiltersComponents
  • OptionalDevContext
  • OptionalSourceMapper
  • OptionalSourceMapperProvider
  • Play
  • UnexpectedException

object Logger extends Logger

High-level API for logging operations.

For example, logging with the default application logger:

Logger.info("Hello!")

Logging with a custom logger:

Logger("my.logger").info("Hello!")
Source
Logger.scala
Linear Supertypes
Logger, LoggerLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Logger
  2. Logger
  3. LoggerLike
  4. AnyRef
  5. 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. def applicationMode: Option[Mode]

    The global application mode currently being used by the logging API.

  5. def apply(clazz: Class[_]): Logger

    Obtains a logger instance.

    Obtains a logger instance.

    clazz

    a class whose name will be used as logger name

    returns

    a logger

  6. def apply(name: String): Logger

    Obtains a logger instance.

    Obtains a logger instance.

    name

    the name of the logger

    returns

    a logger

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val logger: org.slf4j.Logger

    The underlying SLF4J Logger.

    The underlying SLF4J Logger.

    Definition Classes
    Logger → LoggerLike
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def setApplicationMode(mode: Mode): Unit

    Set the global application mode used for logging.

    Set the global application mode used for logging. Used when the Play application starts.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. lazy val underlyingLogger: org.slf4j.Logger

    The underlying SLF4J Logger.

    The underlying SLF4J Logger.

    Definition Classes
    LoggerLike
  23. def unsetApplicationMode(): Unit

    Unset the global application mode.

    Unset the global application mode. Used when the application shuts down.

    If multiple applications are running

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

Deprecated Value Members

  1. def debug(message: ⇒ String, error: ⇒ Throwable)(implicit mc: MarkerContext): Unit

    Logs a message with the DEBUG level.

    Logs a message with the DEBUG level.

    message

    the message to log

    error

    the associated exception

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  2. def debug(message: ⇒ String)(implicit mc: MarkerContext): Unit

    Logs a message with the DEBUG level.

    Logs a message with the DEBUG level.

    message

    the message to log

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  3. def enabled: Boolean
    Definition Classes
    Logger → Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  4. def error(message: ⇒ String, error: ⇒ Throwable)(implicit mc: MarkerContext): Unit

    Logs a message with the ERROR level.

    Logs a message with the ERROR level.

    message

    the message to log

    error

    the associated exception

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  5. def error(message: ⇒ String)(implicit mc: MarkerContext): Unit

    Logs a message with the ERROR level.

    Logs a message with the ERROR level.

    message

    the message to log

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  6. def forMode(mode: Mode*): Logger

    Get a logger that only works when the application is in the given mode(s).

    Get a logger that only works when the application is in the given mode(s).

    If the global application mode has not been set (by calling Logger.setApplicationMode), this has no effect.

    Definition Classes
    Logger → Logger
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  7. def info(message: ⇒ String, error: ⇒ Throwable)(implicit mc: MarkerContext): Unit

    Logs a message with the INFO level.

    Logs a message with the INFO level.

    message

    the message to log

    error

    the associated exception

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  8. def info(message: ⇒ String)(implicit mc: MarkerContext): Unit

    Logs a message with the INFO level.

    Logs a message with the INFO level.

    message

    the message to log

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  9. def isDebugEnabled(implicit mc: MarkerContext): Boolean

    true if the logger instance is enabled for the DEBUG level.

    true if the logger instance is enabled for the DEBUG level.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  10. def isErrorEnabled(implicit mc: MarkerContext): Boolean

    true if the logger instance is enabled for the ERROR level.

    true if the logger instance is enabled for the ERROR level.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  11. def isInfoEnabled(implicit mc: MarkerContext): Boolean

    true if the logger instance is enabled for the INFO level.

    true if the logger instance is enabled for the INFO level.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  12. def isTraceEnabled(implicit mc: MarkerContext): Boolean

    true if the logger instance is enabled for the TRACE level.

    true if the logger instance is enabled for the TRACE level.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  13. def isWarnEnabled(implicit mc: MarkerContext): Boolean

    true if the logger instance is enabled for the WARN level.

    true if the logger instance is enabled for the WARN level.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  14. def trace(message: ⇒ String, error: ⇒ Throwable)(implicit mc: MarkerContext): Unit

    Logs a message with the TRACE level.

    Logs a message with the TRACE level.

    message

    the message to log

    error

    the associated exception

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  15. def trace(message: ⇒ String)(implicit mc: MarkerContext): Unit

    Logs a message with the TRACE level.

    Logs a message with the TRACE level.

    message

    the message to log

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  16. def warn(message: ⇒ String, error: ⇒ Throwable)(implicit mc: MarkerContext): Unit

    Logs a message with the WARN level.

    Logs a message with the WARN level.

    message

    the message to log

    error

    the associated exception

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

  17. def warn(message: ⇒ String)(implicit mc: MarkerContext): Unit

    Logs a message with the WARN level.

    Logs a message with the WARN level.

    message

    the message to log

    mc

    the implicit marker context, if defined.

    Definition Classes
    Logger → LoggerLike
    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Create an instance of via Logger(...) and use the same-named method. Or use SLF4J directly.

Inherited from Logger

Inherited from LoggerLike

Inherited from AnyRef

Inherited from Any

Ungrouped