ninja.utils

Class NinjaPropertiesImpl

java.lang.Object

ninja.utils.NinjaPropertiesImpl

All Implemented Interfaces:

NinjaProperties

public class NinjaPropertiesImpl
extends java.lang.Object
implements NinjaProperties

Field Summary

Fields inherited from interface ninja.utils.NinjaProperties

CONF_FILE_LOCATION_BY_CONVENTION, NINJA_EXTERNAL_CONF, NINJA_EXTERNAL_RELOAD

Constructor Summary

Constructors

Constructor and Description
NinjaPropertiesImpl(NinjaMode ninjaMode)

Method Summary

Modifier and Type	Method and Description
void	bindProperties(com.google.inject.Binder binder)
java.lang.String	get(java.lang.String key) Get a String property or null if it is not there...
java.util.Properties	getAllCurrentNinjaProperties()
java.lang.Boolean	getBoolean(java.lang.String key)
java.lang.Boolean	getBooleanOrDie(java.lang.String key) The "die" method forces this key to be set.
java.lang.Boolean	getBooleanWithDefault(java.lang.String key, java.lang.Boolean defaultValue) Get a Boolean property or a default value when property cannot be found in any configuration file.
java.lang.String	getContextPath() Get the context path on which the application is running That means: - when running on root the context path is empty - when running on context there is NEVER a trailing slash We conform to the following rules: Returns the portion of the request URI that indicates the context of the request.
java.lang.Integer	getInteger(java.lang.String key) Get a property as Integer of null if not there / or property no integer
java.lang.Integer	getIntegerOrDie(java.lang.String key) The "die" method forces this key to be set.
java.lang.Integer	getIntegerWithDefault(java.lang.String key, java.lang.Integer defaultValue) Get a Integer property or a default value when property cannot be found in any configuration file.
java.lang.String	getOrDie(java.lang.String key) The "die" method forces this key to be set.
java.lang.String[]	getStringArray(java.lang.String key) eg.
java.lang.String	getWithDefault(java.lang.String key, java.lang.String defaultValue) Get a String property or a default value when property cannot be found in any configuration file.
boolean	isDev() Whether we are in dev mode
boolean	isProd() Whether we are in prod mode
boolean	isTest() Whether we are in test mode
void	setContextPath(java.lang.String contextPath)
void	setProperty(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NinjaPropertiesImpl

public NinjaPropertiesImpl(NinjaMode ninjaMode)

Method Detail

get

public java.lang.String get(java.lang.String key)

Description copied from interface: NinjaProperties

Get a String property or null if it is not there...

Specified by:

get in interface NinjaProperties

Returns:

the property of null if not there

getOrDie

public java.lang.String getOrDie(java.lang.String key)

Description copied from interface: NinjaProperties

The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.

Specified by:

getOrDie in interface NinjaProperties

Returns:

the String or a RuntimeException will be thrown.

getInteger

public java.lang.Integer getInteger(java.lang.String key)

Description copied from interface: NinjaProperties

Get a property as Integer of null if not there / or property no integer

Specified by:

getInteger in interface NinjaProperties

Returns:

the property or null if not there or property no integer

getIntegerOrDie

public java.lang.Integer getIntegerOrDie(java.lang.String key)

Description copied from interface: NinjaProperties

The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.

Specified by:

getIntegerOrDie in interface NinjaProperties

Returns:

the Integer or a RuntimeException will be thrown.

getBooleanOrDie

public java.lang.Boolean getBooleanOrDie(java.lang.String key)

Description copied from interface: NinjaProperties

The "die" method forces this key to be set. Otherwise a runtime exception will be thrown.

Specified by:

getBooleanOrDie in interface NinjaProperties

Returns:

the boolean or a RuntimeException will be thrown.

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Specified by:

getBoolean in interface NinjaProperties

Returns:

the property or null if not there or property no boolean

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

bindProperties

public void bindProperties(com.google.inject.Binder binder)

isProd

public boolean isProd()

Description copied from interface: NinjaProperties

Whether we are in prod mode

Specified by:

isProd in interface NinjaProperties

Returns:

True if we are in prod mode

isDev

public boolean isDev()

Description copied from interface: NinjaProperties

Whether we are in dev mode

Specified by:

isDev in interface NinjaProperties

Returns:

True if we are in dev mode

isTest

public boolean isTest()

Description copied from interface: NinjaProperties

Whether we are in test mode

Specified by:

isTest in interface NinjaProperties

Returns:

True if we are in test mode

getContextPath

public java.lang.String getContextPath()

Get the context path on which the application is running That means: - when running on root the context path is empty - when running on context there is NEVER a trailing slash We conform to the following rules: Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string. As outlined by: http://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.html#getContextPath()

Specified by:

getContextPath in interface NinjaProperties

Returns:

the context-path with a leading "/" or "" if running on root

setContextPath

public void setContextPath(java.lang.String contextPath)

Specified by:

setContextPath in interface NinjaProperties

getAllCurrentNinjaProperties

public java.util.Properties getAllCurrentNinjaProperties()

Specified by:

getAllCurrentNinjaProperties in interface NinjaProperties

Returns:

All properties that are currently loaded from internal and external files

getStringArray

public java.lang.String[] getStringArray(java.lang.String key)

Description copied from interface: NinjaProperties

eg. key=myval1,myval2 Delimiter is a comma "," as outlined in the example above.

Specified by:

getStringArray in interface NinjaProperties

Returns:

an array containing the values of that key or null if not found.

getWithDefault

public java.lang.String getWithDefault(java.lang.String key,
                                       java.lang.String defaultValue)

Description copied from interface: NinjaProperties

Get a String property or a default value when property cannot be found in any configuration file.

Specified by:

getWithDefault in interface NinjaProperties

Parameters:

key - the key used in the configuration file.

defaultValue - Default value returned, when value cannot be found in configuration.

Returns:

the value of the key or the default value.

getIntegerWithDefault

public java.lang.Integer getIntegerWithDefault(java.lang.String key,
                                               java.lang.Integer defaultValue)

Description copied from interface: NinjaProperties

Get a Integer property or a default value when property cannot be found in any configuration file.

Specified by:

getIntegerWithDefault in interface NinjaProperties

Parameters:

key - the key used in the configuration file.

defaultValue - Default value returned, when value cannot be found in configuration.

Returns:

the value of the key or the default value.

getBooleanWithDefault

public java.lang.Boolean getBooleanWithDefault(java.lang.String key,
                                               java.lang.Boolean defaultValue)

Description copied from interface: NinjaProperties

Get a Boolean property or a default value when property cannot be found in any configuration file.

Specified by:

getBooleanWithDefault in interface NinjaProperties

Parameters:

key - the key used in the configuration file.

defaultValue - Default value returned, when value cannot be found in configuration.

Returns:

the value of the key or the default value.