Package com.powsybl.commons.config

Class AbstractMapModuleConfig

java.lang.Object

com.powsybl.commons.config.AbstractModuleConfig

com.powsybl.commons.config.AbstractMapModuleConfig

All Implemented Interfaces:

ModuleConfig

Direct Known Subclasses:

MapModuleConfig

public abstract class AbstractMapModuleConfig
extends AbstractModuleConfig

Provides implementation for most methods of ModuleConfig, based on a single "mapping" method to be implemented {@link this#getValue(String)}. A FileSystem also needs to be provided to build Path properties.

Author:

Geoffroy Jamgotchian

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMapModuleConfig(FileSystem fs)

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	getOptionalBooleanProperty(String name)
Optional<org.joda.time.DateTime>	getOptionalDateTimeProperty(String name)
OptionalDouble	getOptionalDoubleProperty(String name)
Optional<Float>	getOptionalFloatProperty(String name)
OptionalInt	getOptionalIntProperty(String name)
OptionalLong	getOptionalLongProperty(String name)
Optional<List<Path>>	getOptionalPathListProperty(String name)
Optional<Path>	getOptionalPathProperty(String name)
Optional<List<String>>	getOptionalStringListProperty(String name)
Optional<String>	getOptionalStringProperty(String name)
protected abstract Object	getValue(String propertyName)	Returns the value of the property with the specified name, or null if it does not exist.

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

getBooleanProperty, getBooleanProperty, getClassProperty, getClassProperty, getDateTimeProperty, getDoubleProperty, getDoubleProperty, getEnumProperty, getEnumProperty, getEnumSetProperty, getEnumSetProperty, getFloatProperty, getFloatProperty, getIntervalProperty, getIntProperty, getIntProperty, getLongProperty, getLongProperty, getOptionalClassProperty, getOptionalEnumProperty, getOptionalEnumSetProperty, getOptionalIntervalProperty, 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

Methods inherited from interface com.powsybl.commons.config.ModuleConfig

getPropertyNames, hasProperty

Constructor Detail

AbstractMapModuleConfig

protected AbstractMapModuleConfig(FileSystem fs)

Parameters:

fs - File system to provide Path objects.

Method Detail

getValue

protected abstract Object getValue(String propertyName)

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).

Parameters:

propertyName - The name of the property to be looked up

Returns:

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

getOptionalStringProperty

public Optional<String> getOptionalStringProperty(String name)

getOptionalStringListProperty

public Optional<List<String>> getOptionalStringListProperty(String name)

getOptionalIntProperty

public OptionalInt getOptionalIntProperty(String name)

getOptionalLongProperty

public OptionalLong getOptionalLongProperty(String name)

getOptionalFloatProperty

public Optional<Float> getOptionalFloatProperty(String name)

getOptionalDoubleProperty

public OptionalDouble getOptionalDoubleProperty(String name)

getOptionalBooleanProperty

public Optional<Boolean> getOptionalBooleanProperty(String name)

getOptionalDateTimeProperty

public Optional<org.joda.time.DateTime> getOptionalDateTimeProperty(String name)

getOptionalPathProperty

public Optional<Path> getOptionalPathProperty(String name)

getOptionalPathListProperty

public Optional<List<Path>> getOptionalPathListProperty(String name)