icl_core::KeyValueDirectory< T > Class Template Reference

#include <KeyValueDirectory.h>

List of all members.

Public Member Functions
KeyValueDirectoryIterator< T >	find (const String &query) const
bool	get (const String &key, typename ConvertToRef< T >::ToRef value) const
bool	hasKey (const String &key) const
bool	insert (const String &key, typename ConvertToRef< T >::ToConstRef value)
Private Types
typedef Map< String, T >	KeyValueMap
Private Attributes
KeyValueMap	m_items
Friends
class	KeyValueDirectoryIterator< T >

---

Detailed Description

template<typename T>
class icl_core::KeyValueDirectory< T >

Implements a lightweight key/value directory.

Definition at line 48 of file KeyValueDirectory.h.

---

Member Typedef Documentation

template<typename T>

typedef Map<String, T> icl_core::KeyValueDirectory< T >::KeyValueMap [private]

Definition at line 109 of file KeyValueDirectory.h.

---

Member Function Documentation

template<typename T >

KeyValueDirectoryIterator< T > icl_core::KeyValueDirectory< T >::find

(

const String &

query

)

const

Finds all entries which match the specified query. Boost regular expressions are allowed for the query.

Returns:

An iterator which iterates over all entries, which match the specified query.

Definition at line 35 of file KeyValueDirectory.hpp.

template<typename T>

bool icl_core::KeyValueDirectory< T >::get	(	const String &	key,
		typename ConvertToRef< T >::ToRef	value
	)		const

Get a value for the specified key.

Returns:

true if a configuration value for the key exists, false otherwise.

Definition at line 41 of file KeyValueDirectory.hpp.

template<typename T >

bool icl_core::KeyValueDirectory< T >::hasKey

(

const String &

key

)

const

Check if the key exists.

Definition at line 56 of file KeyValueDirectory.hpp.

template<typename T>

bool icl_core::KeyValueDirectory< T >::insert	(	const String &	key,
		typename ConvertToRef< T >::ToConstRef	value
	)

Insert a new key / value pair.

Returns:

true if a new element was inserted, false if an existing element was replaced.

Definition at line 63 of file KeyValueDirectory.hpp.

---

Friends And Related Function Documentation

template<typename T>

friend class KeyValueDirectoryIterator< T > [friend]

Definition at line 50 of file KeyValueDirectory.h.

---

Member Data Documentation

template<typename T>

KeyValueMap icl_core::KeyValueDirectory< T >::m_items [private]

Definition at line 110 of file KeyValueDirectory.h.

---

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

• KeyValueDirectory.h
• KeyValueDirectory.hpp