Deveel.Data.Configuration.IConfigFormatter Interface Reference

Provides the format to load and store configurations in and from a stream. More...

Inheritance diagram for Deveel.Data.Configuration.IConfigFormatter:

Public Member Functions
void	LoadInto (IConfiguration config, Stream inputStream)
	Loads a stored configuration from the given stream into the configuration argument. More...
void	SaveFrom (IConfiguration config, ConfigurationLevel level, Stream outputStream)
	Stores the given level of configurations into the output stream provided, in the format handled by this interface. More...

Detailed Description

Provides the format to load and store configurations in and from a stream.

Implementations of this interface will apply a specific format to the data stored and retrieved (for example an XML fragmanet, a key/value file, a binary file, etc.).

Definition at line 30 of file IConfigFormatter.cs.

Member Function Documentation

void Deveel.Data.Configuration.IConfigFormatter.LoadInto	(	IConfiguration	config,
		Stream	inputStream
	)

Loads a stored configuration from the given stream into the configuration argument.

Parameters

config	The configuration object inside of which to load the configurations from the the given stream.
inputStream	The stream from where to read the configurations formatted into the object provided as argument.

Exceptions

ArgumentException	If the provided inputStream cannot be read.
ArgumentNullException	If either config or inputStream are null.

Implemented in Deveel.Data.Configuration.PropertiesConfigFormatter.

void Deveel.Data.Configuration.IConfigFormatter.SaveFrom	(	IConfiguration	config,
		ConfigurationLevel	level,
		Stream	outputStream
	)

Stores the given level of configurations into the output stream provided, in the format handled by this interface.

Parameters

config	The source of the configurations to store.
level	The level of the configurations to load from the source and store.
outputStream	The destination stream where the formatter saves the configurations retrieved from the source.

See also

ConfigurationLevel

Exceptions

ArgumentException	If the provided outputStream cannot be written.
ArgumentNullException	If either config or outputStream are null.

Implemented in Deveel.Data.Configuration.PropertiesConfigFormatter.

---

The documentation for this interface was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Configuration/IConfigFormatter.cs