Properties Class Reference

Properties class, which helps out with storeing or loading key value pairs from/to property files. More...

#include <tdme/utilities/Properties.h>

Collaboration diagram for Properties:

Public Member Functions
	Properties ()
	Public constructor. More...
void	clear ()
	Clear. More...
const string &	get (const string &key, const string &defaultValue) const
	Get property value by key. More...
void	put (const string &key, const string &value)
	Add property. More...
void	load (const string &pathName, const string &fileName, FileSystemInterface *fileSystem=nullptr)
	Load property file. More...
void	store (const string &pathName, const string &fileName, FileSystemInterface *fileSystem=nullptr) const
	Store property file. More...
const map< string, string > &	getProperties ()

Private Attributes
map< string, string >	properties

Detailed Description

Properties class, which helps out with storeing or loading key value pairs from/to property files.

Author

Andreas Drewke

Definition at line 22 of file Properties.h.

Constructor & Destructor Documentation

Properties()

Properties

(

)

Public constructor.

Definition at line 22 of file Properties.cpp.

Member Function Documentation

clear()

void clear ( )

inline

Clear.

Definition at line 36 of file Properties.h.

get()

const string & get ( const string &  key, const string &  defaultValue  ) const

inline

Get property value by key.

Parameters

key	key
defaultValue	default value

Returns

value if found or default value

Definition at line 46 of file Properties.h.

getProperties()

const map< string, string > & getProperties ( )

inline

Returns

properties map

Definition at line 83 of file Properties.h.

load()

void load	(	const string &	pathName,
		const string &	fileName,
		FileSystemInterface *	fileSystem = nullptr
	)

Load property file.

Parameters

pathName	path name
fileName	file name
fileSystem	file system to use

Exceptions

tdme::os::filesystem::FileSystemException

Definition at line 26 of file Properties.cpp.

put()

void put ( const string &  key, const string &  value  )

inline

Add property.

Parameters

key	key
value	value

Definition at line 58 of file Properties.h.

store()

void store	(	const string &	pathName,
		const string &	fileName,
		FileSystemInterface *	fileSystem = nullptr
	)		const

Store property file.

Parameters

pathName	path name
fileName	file name
fileSystem	file system to use

Exceptions

tdme::os::filesystem::FileSystemException

Definition at line 43 of file Properties.cpp.

Member Data Documentation

properties

map<string, string> properties

private

Definition at line 25 of file Properties.h.

---

The documentation for this class was generated from the following files:

• /home/andreas/Development/drewke.net/tdme2/src/tdme/utilities/Properties.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/utilities/Properties.cpp