play

Interface Application

All Known Implementing Classes:

DefaultApplication

public interface Application

A Play application.

Application creation is handled by the framework engine.

Method Summary

Modifier and Type	Method and Description
play.api.Application	asScala() Get the application as a Scala application.
default java.lang.ClassLoader	classloader() Get the application classloader.
com.typesafe.config.Config	config() Get the application configuration.
default Configuration	configuration() Deprecated.
default java.io.File	getFile(java.lang.String relativePath) Deprecated. Deprecated as in 2.6.0. Use Environment.getFile(java.lang.String) instead.
play.api.Application	getWrappedApplication() Get the underlying Scala application.
Injector	injector() Get the runtime 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) Deprecated. Deprecated as in 2.6.0. Use Environment.resource(String) instead.
default java.io.InputStream	resourceAsStream(java.lang.String relativePath) Deprecated. Deprecated as in 2.6.0. UseEnvironment.resourceAsStream(String) instead.

Method Detail

getWrappedApplication

play.api.Application getWrappedApplication()

Get the underlying Scala application.

Returns:

the application

See Also:

method

asScala

play.api.Application asScala()

Get the application as a Scala application.

Returns:

this application as a Scala application.

See Also:

Application

configuration

@Deprecated
default Configuration configuration()

Deprecated.

Get the application configuration.

Returns:

the configuration

config

com.typesafe.config.Config config()

Get the application configuration.

Returns:

the configuration

injector

Injector injector()

Get the runtime injector for this application. In a runtime dependency injection based application, this can be used to obtain components as bound by the DI framework.

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

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

Deprecated. Deprecated as in 2.6.0. Use Environment.getFile(java.lang.String) instead.

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

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

Deprecated. Deprecated as in 2.6.0. Use Environment.resource(String) instead.

Get a resource from the classpath.

Parameters:

relativePath - relative path of the resource to fetch

Returns:

URL to the resource (may be null)

resourceAsStream

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

Deprecated. Deprecated as in 2.6.0. UseEnvironment.resourceAsStream(String) instead.

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