Play (Play! API)

java.lang.Object
- play.Play

```
public class Play
extends Object
```
Main framework class

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Play.Mode
2 modes

Nested Classes
Modifier and Type	Class and Description
`static class`	`Play.Mode` 2 modes

Field Summary

Fields
Modifier and Type	Field and Description
`static File`	`applicationPath` The application root
`static ApplicationClasses`	`classes` All loaded application classes
`static ApplicationClassloader`	`classloader` The application classLoader
`static Properties`	`configuration` The app configuration (already resolved from the framework id)
`static Set<VirtualFile>`	`confs` The loaded configuration files
`static String`	`ctxPath` Context path (when several application are deployed on the same host)
`static String`	`defaultWebEncoding` This is used as default encoding everywhere related to the web: request, response, WS
`static boolean`	`forceProd`
`static File`	`frameworkPath` The framework root
`static String`	`id` The framework ID
`static boolean`	`initialized` Is the application initialized
`static List<VirtualFile>`	`javaPath` All paths to search for Java files
`static List<String>`	`langs` The list of supported locales
`static boolean`	`lazyLoadTemplates` Lazy load the templates on demand
`static Play.Mode`	`mode` The application mode
`static Map<String,VirtualFile>`	`modules` Modules
`static Map<String,VirtualFile>`	`modulesRoutes` Plugin routes files
`static PluginCollection`	`pluginCollection` pluginCollection that holds all loaded plugins and all enabled plugins..
`static List<PlayPlugin>`	`plugins` Deprecated.
`static boolean`	`readOnlyTmp` tmp dir is readOnly
`static List<VirtualFile>`	`roots` All paths to search for files
`static VirtualFile`	`routes` Main routes file
`static String`	`secretKey` The very secret key
`static boolean`	`standalonePlayServer` This flag indicates if the app is running in a standalone Play server or as a WAR in an applicationServer
`static boolean`	`started` Is the application started
`static long`	`startedAt` The last time than the application has started
`static List<VirtualFile>`	`templatesPath` All paths to search for templates files
`static File`	`tmpDir` tmp dir
`static boolean`	`usePrecompiled`
`static String`	`version` Framework version

Constructor Summary

Constructors
Constructor and Description

Play()

Constructors
Constructor and Description
`Play()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addModule(String name, File path)` Add a play application (as plugin)
`static void`	`addModule(VirtualFile appRoot, String name, File path)` Add a play application (as plugin)
`static void`	`detectChanges()` Detect sources modifications
`static void`	`fatalServerErrorOccurred()` Call this method when there has been a fatal error that Play cannot recover from
`static File`	`getFile(String path)` Search a File in the current application
`static VirtualFile`	`getVirtualFile(String path)` Search a VirtualFile in all loaded applications and plugins
`static void`	`guessFrameworkPath()`
`static void`	`init(File root, String id)` Init the framework
`static void`	`initStaticStuff()` Allow some code to run very early in Play - Use with caution !
`static void`	`loadModules()` Load all modules.
`static void`	`loadModules(VirtualFile appRoot)` Load all modules.
`static <T> T`	`plugin(Class<T> clazz)`
`static void`	`readConfiguration()` Read application.conf and resolve overriden key using the play id mechanism.
`static boolean`	`runingInTestMode()` Returns true if application is runing in test-mode.
`static void`	`start()` Start the application.
`static void`	`stop()` Stop the application
`static boolean`	`useDefaultMockMailSystem()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - initialized
```
public static boolean initialized
```
    Is the application initialized
  - started
```
public static boolean started
```
    Is the application started
  - id
```
public static String id
```
    The framework ID
  - mode
```
public static Play.Mode mode
```
    The application mode
  - applicationPath
```
public static File applicationPath
```
    The application root
  - tmpDir
```
public static File tmpDir
```
    tmp dir
  - readOnlyTmp
```
public static boolean readOnlyTmp
```
    tmp dir is readOnly
  - frameworkPath
```
public static File frameworkPath
```
    The framework root
  - classes
```
public static ApplicationClasses classes
```
    All loaded application classes
  - classloader
```
public static ApplicationClassloader classloader
```
    The application classLoader
  - roots
```
public static List<VirtualFile> roots
```
    All paths to search for files
  - javaPath
```
public static List<VirtualFile> javaPath
```
    All paths to search for Java files
  - templatesPath
```
public static List<VirtualFile> templatesPath
```
    All paths to search for templates files
  - routes
```
public static VirtualFile routes
```
    Main routes file
  - modulesRoutes
```
public static Map<String,VirtualFile> modulesRoutes
```
    Plugin routes files
  - confs
```
public static Set<VirtualFile> confs
```
    The loaded configuration files
  - configuration
```
public static Properties configuration
```
    The app configuration (already resolved from the framework id)
  - startedAt
```
public static long startedAt
```
    The last time than the application has started
  - langs
```
public static List<String> langs
```
    The list of supported locales
  - secretKey
```
public static String secretKey
```
    The very secret key
  - pluginCollection
```
public static PluginCollection pluginCollection
```
    pluginCollection that holds all loaded plugins and all enabled plugins..
  - plugins
```
@Deprecated
public static List<PlayPlugin> plugins
```
    Deprecated.
    
    Readonly list containing currently enabled plugins. This list is updated from pluginCollection when pluginCollection is modified Play plugins Use pluginCollection instead.
  - modules
```
public static Map<String,VirtualFile> modules
```
    Modules
  - version
```
public static String version
```
    Framework version
  - ctxPath
```
public static String ctxPath
```
    Context path (when several application are deployed on the same host)
  - usePrecompiled
```
public static boolean usePrecompiled
```
  - forceProd
```
public static boolean forceProd
```
  - lazyLoadTemplates
```
public static boolean lazyLoadTemplates
```
    Lazy load the templates on demand
  - defaultWebEncoding
```
public static String defaultWebEncoding
```
    This is used as default encoding everywhere related to the web: request, response, WS
  - standalonePlayServer
```
public static boolean standalonePlayServer
```
    This flag indicates if the app is running in a standalone Play server or as a WAR in an applicationServer
- Constructor Detail
  - Play
```
public Play()
```
- Method Detail
  - init
```
public static void init(File root,
        String id)
```
    Init the framework
    
    Parameters:
    root - The application path
    id - The framework id to use
  - guessFrameworkPath
```
public static void guessFrameworkPath()
```
  - readConfiguration
```
public static void readConfiguration()
```
    Read application.conf and resolve overriden key using the play id mechanism.
  - start
```
public static void start()
```
    Start the application. Recall to restart !
  - stop
```
public static void stop()
```
    Stop the application
  - detectChanges
```
public static void detectChanges()
```
    Detect sources modifications
  - plugin
```
public static <T> T plugin(Class<T> clazz)
```
  - initStaticStuff
```
public static void initStaticStuff()
```
    Allow some code to run very early in Play - Use with caution !
  - loadModules
```
public static void loadModules()
```
    Load all modules. You can even specify the list using the MODULES environment variable.
  - loadModules
```
public static void loadModules(VirtualFile appRoot)
```
    Load all modules. You can even specify the list using the MODULES environment variable.
    
    Parameters:
    appRoot - : the application path virtual file
  - addModule
```
public static void addModule(String name,
             File path)
```
    Add a play application (as plugin)
    
    Parameters:
    name - : the module name
    path - The application path
  - addModule
```
public static void addModule(VirtualFile appRoot,
             String name,
             File path)
```
    Add a play application (as plugin)
    
    Parameters:
    appRoot - : the application path virtual file
    name - : the module name
    path - The application path
  - getVirtualFile
```
public static VirtualFile getVirtualFile(String path)
```
    Search a VirtualFile in all loaded applications and plugins
    
    Parameters:
    path - Relative path from the applications root
    
    Returns:
    The virtualFile or null
  - getFile
```
public static File getFile(String path)
```
    Search a File in the current application
    
    Parameters:
    path - Relative path from the application root
    
    Returns:
    The file even if it doesn't exist
  - runingInTestMode
```
public static boolean runingInTestMode()
```
    Returns true if application is runing in test-mode. Test-mode is resolved from the framework id. Your app is running in test-mode if the framwork id (Play.id) is 'test' or 'test-?.*'
    
    Returns:
    true if testmode
  - fatalServerErrorOccurred
```
public static void fatalServerErrorOccurred()
```
    Call this method when there has been a fatal error that Play cannot recover from
  - useDefaultMockMailSystem
```
public static boolean useDefaultMockMailSystem()
```

Class Play

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

initialized

started

id

mode

applicationPath

tmpDir

readOnlyTmp

frameworkPath

classes

classloader

roots

javaPath

templatesPath

routes

modulesRoutes

confs

configuration

startedAt

langs

secretKey

pluginCollection

plugins

modules

version

ctxPath

usePrecompiled

forceProd

lazyLoadTemplates

defaultWebEncoding

standalonePlayServer

Constructor Detail

Play

Method Detail

init

guessFrameworkPath

readConfiguration

start

stop

detectChanges

plugin

initStaticStuff

loadModules

loadModules

addModule

addModule

getVirtualFile

getFile

runingInTestMode

fatalServerErrorOccurred

useDefaultMockMailSystem