org.codice.ddf.platform.io

Class CfgStrategy

java.lang.Object

org.codice.ddf.platform.io.CfgStrategy

All Implemented Interfaces:

PersistenceStrategy

public class CfgStrategy
extends Object
implements PersistenceStrategy

Class that persists configuration properties using the Felix .cfg file format.

All values are stored as strings. The returned Dictionary from read(InputStream) will always consist of string values that must be separately parsed or processed by the caller, even if they weren't strings when handed to write(OutputStream, Dictionary).

Not recommended for use with complex objects such as arrays or maps. Where possible, use .config and ConfigStrategy instead.

Field Summary

Fields inherited from interface org.codice.ddf.platform.io.internal.PersistenceStrategy

STRATEGY_EXTENSION

Constructor Summary

Constructors

Constructor and Description
CfgStrategy()

Method Summary

Modifier and Type	Method and Description
String	getExtension() Gets the extension handled by this strategy.
Dictionary<String,Object>	read(InputStream in) Reads the configuration properties from an InputStream.
void	write(OutputStream out, Dictionary<String,Object> inputDictionary) Writes the configuration properties to an OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

CfgStrategy

public CfgStrategy()

Method Detail

getExtension

public String getExtension()

Description copied from interface: PersistenceStrategy

Gets the extension handled by this strategy.

Specified by:

getExtension in interface PersistenceStrategy

Returns:

the extension (without the prefix .) handled by this strategy

write

public void write(OutputStream out,
                  Dictionary<String,Object> inputDictionary)
           throws IOException

Description copied from interface: PersistenceStrategy

Writes the configuration properties to an OutputStream. The stream will not be closed automatically.

Specified by:

write in interface PersistenceStrategy

Parameters:

out - output stream where the properties will be written

inputDictionary - properties to write

Throws:

IOException - thrown if the properties couldn't be written

read

public Dictionary<String,Object> read(InputStream in)
                               throws IOException

Description copied from interface: PersistenceStrategy

Reads the configuration properties from an InputStream. The stream will not be closed automatically.

Specified by:

read in interface PersistenceStrategy

Parameters:

in - input stream where the properties will be read from

Returns:

the properties read

Throws:

IOException - thrown if the properties couldn't be read