Environment (Play 2.6.12)

java.lang.Object
- play.Environment

```
@Singleton
public class Environment
extends java.lang.Object
```
The environment for the application. Captures concerns relating to the classloader and the filesystem for the application.

Constructor Summary

Constructors
Constructor and Description
`Environment(play.api.Environment environment)`
`Environment(java.io.File rootPath)`
`Environment(java.io.File rootPath, java.lang.ClassLoader classLoader, Mode mode)`
`Environment(java.io.File rootPath, Mode mode)`
`Environment(Mode mode)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`play.api.Environment`	`asScala()` The underlying Scala API Environment object that this Environment wraps.
`java.lang.ClassLoader`	`classLoader()` The classloader that all application classes and resources can be loaded from.
`java.util.Optional<java.io.File>`	`getExistingFile(java.lang.String relativePath)` Retrieves a file relative to the application root path.
`java.io.File`	`getFile(java.lang.String relativePath)` Retrieves a file relative to the application root path.
`boolean`	`isDev()` Returns `true` if the application is `DEV` mode.
`boolean`	`isProd()` Returns `true` if the application is `PROD` mode.
`boolean`	`isTest()` Returns `true` if the application is `TEST` mode.
`Mode`	`mode()` The mode of the application.
`java.net.URL`	`resource(java.lang.String relativePath)` Retrieves a resource from the classpath.
`java.io.InputStream`	`resourceAsStream(java.lang.String relativePath)` Retrieves a resource stream from the classpath.
`java.io.File`	`rootPath()` The root path that the application is deployed at.
`static Environment`	`simple()` A simple environment.
`play.api.Environment`	`underlying()` Deprecated. As of release 2.6.0. Use `asScala()`

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

- Constructor Detail
  - Environment
```
@Inject
public Environment(play.api.Environment environment)
```
  - Environment
```
public Environment(java.io.File rootPath,
                   java.lang.ClassLoader classLoader,
                   Mode mode)
```
  - Environment
```
public Environment(java.io.File rootPath,
                   Mode mode)
```
  - Environment
```
public Environment(java.io.File rootPath)
```
  - Environment
```
public Environment(Mode mode)
```
- Method Detail
  - rootPath
```
public java.io.File rootPath()
```
    The root path that the application is deployed at.
    
    Returns:
    
    the path
  - classLoader
```
public java.lang.ClassLoader classLoader()
```
    The classloader that all application classes and resources can be loaded from.
    
    Returns:
    
    the class loader
  - mode
```
public Mode mode()
```
    The mode of the application.
    
    Returns:
    
    the mode
  - isDev
```
public boolean isDev()
```
    Returns `true` if the application is `DEV` mode.
    
    Returns:
    
    `true` if the application is `DEV` mode.
  - isProd
```
public boolean isProd()
```
    Returns `true` if the application is `PROD` mode.
    
    Returns:
    
    `true` if the application is `PROD` mode.
  - isTest
```
public boolean isTest()
```
    Returns `true` if the application is `TEST` mode.
    
    Returns:
    
    `true` if the application is `TEST` mode.
  - 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
  - getExistingFile
```
public java.util.Optional<java.io.File> getExistingFile(java.lang.String relativePath)
```
    Retrieves a file relative to the application root path. This method returns an Optional, using empty if the file was not found.
    
    Parameters:
    
    relativePath - relative path of the file to fetch
    
    Returns:
    
    an existing file
  - 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)
  - simple
```
public static Environment simple()
```
    A simple environment. Uses the same classloader that the environment classloader is defined in, the current working directory as the path and test mode.
    
    Returns:
    
    the environment
  - underlying
```
@Deprecated
public play.api.Environment underlying()
```
    Deprecated. As of release 2.6.0. Use asScala()
    
    The underlying Scala API Environment object that this Environment wraps.
    
    Returns:
    
    the environment
  - asScala
```
public play.api.Environment asScala()
```
    The underlying Scala API Environment object that this Environment wraps.
    
    Returns:
    
    the environment
    
    See Also:
    
    Environment

Class Environment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Environment

Environment

Environment

Environment

Environment

Method Detail

rootPath

classLoader

mode

isDev

isProd

isTest

getFile

getExistingFile

resource

resourceAsStream

simple

underlying

asScala