br.com.caelum.vraptor.environment

Interface Environment

All Known Implementing Classes:

DefaultEnvironment, NullEnvironment, ServletBasedEnvironment

public interface Environment

An environment has a set of key/value properties to be used within your application

Author:

Alexandre Atoji, Guilherme Silveira

Method Summary

Modifier and Type	Method and Description
String	get(String string) Returns a key
String	get(String string, String defaultValue) Returns a key or a default value if the value isn't set
Iterable<String>	getKeys()
String	getName() Returns the environment name
URL	getResource(String name) Locates a resource according to your current environment.
boolean	has(String key) Checks if a key is present
boolean	isDevelopment() An alias to supports(String) with EnvironmentType.DEVELOPMENT.
boolean	isProduction() An alias to supports(String) with EnvironmentType.PRODUCTION.
boolean	isTest() An alias to supports(String) with EnvironmentType.TEST.
void	set(String key, String value) Sets a key in memory.
boolean	supports(String feature) Checks if a key is equals to true if it's not present will return false

Method Detail

getName

String getName()

Returns the environment name

has

boolean has(String key)

Checks if a key is present

supports

boolean supports(String feature)

Checks if a key is equals to true if it's not present will return false

get

String get(String string)

Returns a key

get

String get(String string,
           String defaultValue)

Returns a key or a default value if the value isn't set

set

void set(String key,
         String value)

Sets a key in memory. This will *not* affect any configuration file.

getKeys

Iterable<String> getKeys()

Returns:

an Iterable with all keys

isProduction

boolean isProduction()

An alias to supports(String) with EnvironmentType.PRODUCTION.

isDevelopment

boolean isDevelopment()

An alias to supports(String) with EnvironmentType.DEVELOPMENT.

isTest

boolean isTest()

An alias to supports(String) with EnvironmentType.TEST.

getResource

URL getResource(String name)

Locates a resource according to your current environment.