play
Class Application

java.lang.Object
  play.Application

public class Application
extends java.lang.Object

A Play application.

Application creation is handled by the framework engine.

Application

public Application(play.api.Application application)

Creates an application from a Scala Application value.

path

public java.io.File path()

Retrieves the application path.

Returns:

the application path

configuration

public Configuration configuration()

Retrieves the application configuration/

Returns:

the application path

classloader

public java.lang.ClassLoader classloader()

Retrieves the application classloader.

Returns:

the application classloader

getFile

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

Retrieves 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

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

Retrieves a resource from the classpath.

Parameters:

relativePath - relative path of the resource to fetch

Returns:

URL to the resource (may be null)

resourceAsStream

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

Retrieves a resource stream from the classpath.

Parameters:

relativePath - relative path of the resource to fetch

Returns:

InputStream to the resource (may be null)

plugin

public <T> T plugin(java.lang.Class<T> pluginClass)

Retrieve the plugin instance for the class.

getTypesAnnotatedWith

public java.util.Set<java.lang.String> getTypesAnnotatedWith(java.lang.String packageName,
                                                             java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Scans the application classloader to retrieve all types annotated with a specific annotation.

This method is useful for some plug-ins, for example the EBean plugin will automatically detect all types annotated with @javax.persistance.Entity.

Note that it is better to specify a very specific package to avoid expensive searches.

Parameters:

packageName - the root package to scan

annotation - annotation class

Returns:

a set of types names statifying the condition

isDev

public boolean isDev()

Returns `true` if the application is `DEV` mode.

isProd

public boolean isProd()

Returns `true` if the application is `PROD` mode.

isTest

public boolean isTest()

Returns `true` if the application is `TEST` mode.