Application

Abstract Value Members

abstract def classloader: ClassLoader

The application's classloader
abstract def configuration: Configuration
abstract def global: GlobalSettings
abstract def mode: Mode.Mode

Dev, Prod or Test
abstract def path: File

The absolute path hosting this application, mainly used by the getFile(path) helper method
abstract def plugins: Seq[Plugin]
abstract def sources: Option[SourceMapper]

The SourceMapper used to retrieve source code displayed in error pages

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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getExistingFile(relativePath: String): Option[File]

Retrieves a file relative to the application root path.
Retrieves a file relative to the application root path. This method returns an Option[File], using None if the file was not found.
For example, to retrieve a configuration file:
```
val myConf = application.getExistingFile("conf/myConf.yml")
```
relativePath
the relative path of the file to fetch
returns
an existing file
def getFile(relativePath: String): File

Retrieves a file relative to the application root path.
Retrieves a file relative to the application root path.
For example, to retrieve a configuration file:
```
val myConf = application.getFile("conf/myConf.yml")
```
relativePath
relative path of the file to fetch
returns
a file instance; it is not guaranteed that the file exists
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def plugin[T](implicit ct: ClassTag[T]): Option[T]

Retrieves a plugin of type T.
Retrieves a plugin of type T.
For example, to retrieve the DBPlugin instance:
```
val dbPlugin = application.plugin[DBPlugin].map(_.api).getOrElse(sys.error("problem with the plugin"))
```
T
the plugin type
returns
The plugin instance used by this application.

Exceptions thrown
Error
if no plugins of type T are loaded by this application.
def plugin[T](pluginClass: Class[T]): Option[T]

Retrieves a plugin of type T.
Retrieves a plugin of type T.
For example, retrieving the DBPlugin instance:
```
val dbPlugin = application.plugin(classOf[DBPlugin])
```
T
the plugin type
pluginClass
the plugin’s class
returns
the plugin instance, wrapped in an option, used by this application

Exceptions thrown
Error
if no plugins of type T are loaded by this application
def resource(name: String): Option[URL]

Scans the application classloader to retrieve a resource.
Scans the application classloader to retrieve a resource.
For example, to retrieve a configuration file:
```
val maybeConf = application.resource("conf/logger.xml")
```
name
the absolute name of the resource (from the classpath root)
returns
the resource URL, if found
def resourceAsStream(name: String): Option[InputStream]

Scans the application classloader to retrieve a resource’s contents as a stream.
Scans the application classloader to retrieve a resource’s contents as a stream.
For example, to retrieve a configuration file:
```
val maybeConf = application.resourceAsStream("conf/logger.xml")
```
name
the absolute name of the resource (from the classpath root)
returns
a stream, if found
lazy val routes: Option[core.Router.Routes]

The router used by this application (if defined).
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 Application extends AnyRef

Abstract Value Members

abstract def classloader: ClassLoader

abstract def configuration: Configuration

abstract def global: GlobalSettings

abstract def mode: Mode.Mode

abstract def path: File

abstract def plugins: Seq[Plugin]

abstract def sources: Option[SourceMapper]

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 getExistingFile(relativePath: String): Option[File]

def getFile(relativePath: String): File

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def plugin[T](implicit ct: ClassTag[T]): Option[T]

def plugin[T](pluginClass: Class[T]): Option[T]

def resource(name: String): Option[URL]

def resourceAsStream(name: String): Option[InputStream]

lazy val routes: Option[core.Router.Routes]

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

def toString(): String

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