Package com.powsybl.commons.config

Class EnvironmentMapModuleConfig

java.lang.Object

com.powsybl.commons.config.AbstractModuleConfig

com.powsybl.commons.config.AbstractMapModuleConfig

com.powsybl.commons.config.MapModuleConfig

com.powsybl.commons.config.EnvironmentMapModuleConfig

All Implemented Interfaces:

ModuleConfig

public class EnvironmentMapModuleConfig
extends MapModuleConfig

A ModuleConfig designed to read property values from the map of environment variables. For a configuration property named "property-name" in module "module-name", the expected environment variables name is MODULE_NAME__PROPERTY_NAME. CamelCase names are also translated to underscore-separated names.

Author:

Yichen TANG <yichen.tang at rte-france.com>

Constructor Summary

Constructors

Constructor	Description
EnvironmentMapModuleConfig(Map<Object,Object> properties, FileSystem fs, String moduleName)

Method Summary

Modifier and Type	Method	Description
Set<String>	getPropertyNames()
protected Object	getValue(String propertyName)	Returns the value of the property with the specified name, or null if it does not exist.
boolean	hasProperty(String name)

Methods inherited from class com.powsybl.commons.config.MapModuleConfig

setClassProperty, setPathProperty, setStringListProperty, setStringProperty

Methods inherited from class com.powsybl.commons.config.AbstractMapModuleConfig

getOptionalBooleanProperty, getOptionalDateTimeProperty, getOptionalDoubleProperty, getOptionalFloatProperty, getOptionalIntProperty, getOptionalLongProperty, getOptionalPathListProperty, getOptionalPathProperty, getOptionalStringListProperty, getOptionalStringProperty

Methods inherited from class com.powsybl.commons.config.AbstractModuleConfig

getBooleanProperty, getBooleanProperty, getClassProperty, getClassProperty, getDateTimeProperty, getDoubleProperty, getDoubleProperty, getEnumProperty, getEnumProperty, getEnumSetProperty, getEnumSetProperty, getFloatProperty, getFloatProperty, getIntProperty, getIntProperty, getLongProperty, getLongProperty, getOptionalClassProperty, getOptionalEnumProperty, getOptionalEnumSetProperty, getPathListProperty, getPathProperty, getPathProperty, getStringListProperty, getStringListProperty, getStringProperty, getStringProperty

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentMapModuleConfig

public EnvironmentMapModuleConfig(Map<Object,Object> properties,
 FileSystem fs,
 String moduleName)

Method Details

hasProperty

public boolean hasProperty(String name)

Specified by:

hasProperty in interface ModuleConfig

Overrides:

hasProperty in class MapModuleConfig

getValue

protected Object getValue(String propertyName)

Description copied from class: AbstractMapModuleConfig

Returns the value of the property with the specified name, or null if it does not exist. The returned object may be a String or directly a more specialized type (Date or Float for instance).

Overrides:

getValue in class MapModuleConfig

Parameters:

propertyName - The name of the property to be looked up

Returns:

The value of the specified property it it exists, null otherwise.

getPropertyNames

public Set<String> getPropertyNames()

Specified by:

getPropertyNames in interface ModuleConfig

Overrides:

getPropertyNames in class MapModuleConfig