org.jboss.gravia.runtime.spi

Interface PropertiesProvider

All Known Implementing Classes:

AbstractPropertiesProvider, CompositePropertiesProvider, DefaultPropertiesProvider, EnvPropertiesProvider, MapPropertiesProvider, RuntimePropertiesProvider, SubstitutionPropertiesProvider, SystemPropertiesProvider

public interface PropertiesProvider

A provider for Runtime properties.

Since:

27-Sep-2013

Author:

thomas.diesler@jboss.com

Method Summary

Methods

Modifier and Type	Method and Description
Object	getProperty(String key) Returns the value of the specified property.
Object	getProperty(String key, Object defaultValue) Returns the value of the specified property.
Object	getRequiredProperty(String key) Returns the value of the specified property.

Method Detail

getProperty

Object getProperty(String key)

Returns the value of the specified property. If the key is not found in the Runtime properties, the system properties are then searched. The method returns null if the property is not found.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property, or null if the property is undefined.

getRequiredProperty

Object getRequiredProperty(String key)

Returns the value of the specified property. If the key is not found in the Runtime properties, the system properties are then searched. The method throws an IllegalStateException if the property is not found.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property

Throws:

IllegalStateException - if the property is undefined.

getProperty

Object getProperty(String key,
                 Object defaultValue)

Returns the value of the specified property. If the key is not found in the Runtime properties, the system properties are then searched. The method returns provided default value if the property is not found.

Parameters:

key - The name of the requested property.

Returns:

The value of the requested property, or the provided default value if the property is undefined.