com.powsybl.commons.config

Class PlatformConfig

java.lang.Object

com.powsybl.commons.config.PlatformConfig

Direct Known Subclasses:

InMemoryPlatformConfig

public class PlatformConfig
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.Path	configDir
protected ModuleConfigRepository	repository

Constructor Summary

Constructors

Modifier	Constructor and Description
	PlatformConfig(ModuleConfigRepository repository)
	PlatformConfig(ModuleConfigRepository repository, java.nio.file.FileSystem fileSystem)
protected	PlatformConfig(ModuleConfigRepository repository, java.nio.file.Path configDir)

Method Summary

Modifier and Type	Method and Description
static PlatformConfig	defaultConfig()
java.nio.file.Path	getConfigDir()
ModuleConfig	getModuleConfig(java.lang.String name)
java.util.Optional<ModuleConfig>	getOptionalModuleConfig(java.lang.String name)
static ModuleConfigRepository	loadDefaultModuleRepository() Loads the default ModuleConfigRepository.
boolean	moduleExists(java.lang.String name)
static void	setDefaultConfig(PlatformConfig defaultConfig) Deprecated. Directly pass PlatformConfig instance to the code you want to test.

Methods inherited from class java.lang.Object

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

Field Detail

configDir

protected final java.nio.file.Path configDir

repository

protected final ModuleConfigRepository repository

Constructor Detail

PlatformConfig

public PlatformConfig(ModuleConfigRepository repository)

PlatformConfig

public PlatformConfig(ModuleConfigRepository repository,
                      java.nio.file.FileSystem fileSystem)

PlatformConfig

protected PlatformConfig(ModuleConfigRepository repository,
                         java.nio.file.Path configDir)

Method Detail

setDefaultConfig

@Deprecated
public static void setDefaultConfig(PlatformConfig defaultConfig)

Deprecated. Directly pass PlatformConfig instance to the code you want to test.

loadDefaultModuleRepository

public static ModuleConfigRepository loadDefaultModuleRepository()

Loads the default ModuleConfigRepository. Configuration properties are read from environment variables and from the list of directories defined by the system properties "powsybl.config.dirs" or "itools.config.dir", or by default from ${HOME}/.itools. Configuration properties values from environment variables take precedence over the values defined in config directories. Configuration properties values encountered first in the list of directories take precedence over the values defined in subsequent directories.

defaultConfig

public static PlatformConfig defaultConfig()

getConfigDir

public java.nio.file.Path getConfigDir()

moduleExists

public boolean moduleExists(java.lang.String name)

getModuleConfig

public ModuleConfig getModuleConfig(java.lang.String name)

getOptionalModuleConfig

public java.util.Optional<ModuleConfig> getOptionalModuleConfig(java.lang.String name)