image— type: docs title: “YamlConfigReader” linkTitle: “YamlConfigReader” gitUrl: “https://github.com/pip-services4/pip-services4-java/tree/main/pip-services4-config-java" description: > Config reader that reads configuration from YAML file.

Extends: FileConfigReader

Description

The YamlConfigReader allows you to create a config reader that reads a configuration from a YAML file.

Configuration parameters

Constructors

Creates a new instance of the config reader.

public YamlConfigReader(String path)

Instance methods

readConfig

Reads a configuration and parameterizes it with given values.

public ConfigParams readConfig(IContext context, ConfigParams parameters) throws ApplicationException

readObject

Reads a configuration file, parameterizes its content and converts it into a YAML object.

public Object readObject(IContext context, String path, ConfigParams parameters) throws ApplicationException

readConfig

Reads a configuration from a file, parameterizes it with given values and returns a new ConfigParams object.

public ConfigParams readConfig(IContext context, ConfigParams parameters) throws ApplicationException

Static methods

readObject

Reads a configuration file, parameterizes its content and converts it into a YAML object.

public static Object readObject(IContext context, String path, ConfigParams parameters)

Examples

key1: "{{KEY1_VALUE}}"
key2: "{{KEY2_VALUE}}"

{
  YamlConfigReader configReader = new YamlConfigReader("config.yml");
  
  ConfigParams parameters = ConfigParams.fromTuples("KEY1_VALUE", 123, "KEY2_VALUE", "ABC");
  configReader.readConfig("123", parameters);
  }

See also