Package org.pipservices3.components.config

Class FileConfigReader

java.lang.Object

org.pipservices3.components.config.ConfigReader

org.pipservices3.components.config.FileConfigReader

All Implemented Interfaces:

org.pipservices3.commons.config.IConfigurable, IConfigReader

Direct Known Subclasses:

JsonConfigReader, YamlConfigReader

public abstract class FileConfigReader
extends ConfigReader
implements org.pipservices3.commons.config.IConfigurable

Abstract config reader that reads configuration from a file. Child classes add support for config files in their specific format like JSON, YAML or property files.

### Configuration parameters ###

• path: path to configuration file
• parameters: this entire section is used as template parameters
• ...

See Also:

IConfigReader, ConfigReader

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_path

Constructor Summary

Constructors

Constructor	Description
FileConfigReader()	Creates a new instance of the config reader.
FileConfigReader(String path)	Creates a new instance of the config reader.

Method Summary

Modifier and Type	Method	Description
void	configure(org.pipservices3.commons.config.ConfigParams config)	Configures component by passing configuration parameters.
String	getPath()	Get the path to configuration file..
void	setPath(String value)	Set the path to configuration file.

Methods inherited from class org.pipservices3.components.config.ConfigReader

parameterize, readConfig

Methods inherited from class java.lang.Object

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

Field Details

_path

protected String _path

Constructor Details

FileConfigReader

public FileConfigReader()

Creates a new instance of the config reader.

FileConfigReader

public FileConfigReader(String path)

Creates a new instance of the config reader.

Parameters:

path - (optional) a path to configuration file.

Method Details

getPath

public String getPath()

Get the path to configuration file..

Returns:

the path to configuration file.

setPath

public void setPath(String value)

Set the path to configuration file.

Parameters:

value - a new path to configuration file.

configure

public void configure(org.pipservices3.commons.config.ConfigParams config)

Configures component by passing configuration parameters.

Specified by:

configure in interface org.pipservices3.commons.config.IConfigurable

Overrides:

configure in class ConfigReader

Parameters:

config - configuration parameters to be set.