play

Interface Application

All Known Implementing Classes:

DefaultApplication, FakeApplication

public interface Application

A Play application. Application creation is handled by the framework engine.

Method Summary

Modifier and Type	Method and Description
default java.lang.ClassLoader	classloader() Get the application classloader.
Configuration	configuration() Get the application configuration.
default java.io.File	getFile(java.lang.String relativePath) Get a file relative to the application root path.
play.api.Application	getWrappedApplication() Get the underlying Scala application.
Injector	injector() Get the injector for this application.
default boolean	isDev() Check whether the application is in Mode.DEV mode.
default boolean	isProd() Check whether the application is in Mode.PROD mode.
default boolean	isTest() Check whether the application is in Mode.TEST mode.
default java.io.File	path() Get the application path.
default java.net.URL	resource(java.lang.String relativePath) Get a resource from the classpath.
default java.io.InputStream	resourceAsStream(java.lang.String relativePath) Get a resource stream from the classpath.

Method Detail

getWrappedApplication

play.api.Application getWrappedApplication()

Get the underlying Scala application.

Returns:

the application

configuration

Configuration configuration()

Get the application configuration.

Returns:

the configuration

injector

Injector injector()

Get the injector for this application.

Returns:

the injector

path

default java.io.File path()

Get the application path.

Returns:

the application path

classloader

default java.lang.ClassLoader classloader()

Get the application classloader.

Returns:

the application classloader

getFile

default java.io.File getFile(java.lang.String relativePath)

Get a file relative to the application root path.

Parameters:

relativePath - relative path of the file to fetch

Returns:

a file instance - it is not guaranteed that the file exists

resource

default java.net.URL resource(java.lang.String relativePath)

Get a resource from the classpath.

Parameters:

relativePath - relative path of the resource to fetch

Returns:

URL to the resource (may be null)

resourceAsStream

default java.io.InputStream resourceAsStream(java.lang.String relativePath)

Get a resource stream from the classpath.

Parameters:

relativePath - relative path of the resource to fetch

Returns:

InputStream to the resource (may be null)

isDev

default boolean isDev()

Check whether the application is in Mode.DEV mode.

Returns:

true if the application is in DEV mode

isProd

default boolean isProd()

Check whether the application is in Mode.PROD mode.

Returns:

true if the application is in PROD mode

isTest

default boolean isTest()

Check whether the application is in Mode.TEST mode.

Returns:

true if the application is in TEST mode