lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor > Class Template Reference

A template to encapsulate various map type classes. More...

#include <VoidMap.h>

Inheritance diagram for lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >:

List of all members.

Public Types
typedef _base::iterator	iterator
typedef _base::const_iterator	const_iterator
typedef std::pair< _kt, _vt >	_pair
Public Member Functions
	__CLMap ()
	Default constructor for the __CLMap.
	~__CLMap ()
	Deconstructor for the __CLMap.
void	setDeleteKey (bool val)
void	setDeleteValue (bool val)
bool	exists (_kt k) const
	Construct the VoidMap and set the deleteTypes to the specified values.
void	put (_kt k, _vt v)
	put the specified pair into the map.
_vt	get (_kt k) const
	using a non-const key, get a non-const value
_kt	getKey (_kt k) const
	using a non-const key, get the actual key
void	removeitr (iterator itr, const bool dontDeleteKey=false, const bool dontDeleteValue=false)
void	remove (_kt key, const bool dontDeleteKey=false, const bool dontDeleteValue=false)
	delete and optionally delete the specified key and associated value
void	clear ()
	clear all keys and values in the map

---

Detailed Description

template<typename _kt, typename _vt, typename _base, typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>
class lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >

A template to encapsulate various map type classes.

---

Member Typedef Documentation

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

typedef std:: pair<_kt, _vt> lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::_pair

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

typedef _base::const_iterator lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::const_iterator

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

typedef _base::iterator lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::iterator

---

Constructor & Destructor Documentation

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::__CLMap

(

)

[inline]

Default constructor for the __CLMap.

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::~__CLMap

(

)

[inline]

Deconstructor for the __CLMap.

---

Member Function Documentation

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

void lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::clear

(

)

[inline]

clear all keys and values in the map

Referenced by lucene::util::ThreadLocal< T, _deletor >::~ThreadLocal().

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

bool lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::exists

(

_kt

k

)

const [inline]

Construct the VoidMap and set the deleteTypes to the specified values.

Parameters:

	deleteKey	if true then the key variable is deleted when an object is deleted
	keyDelType	delete the key variable using the specified type
	deleteValue	if true then the value variable is deleted when an object is deleted
	valueDelType	delete the value variable using the specified type checks to see if the specified key exists
	k	the key to check for

Returns:

true if the key exists

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

_vt lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::get

(

_kt

k

)

const [inline]

using a non-const key, get a non-const value

Referenced by lucene::util::ThreadLocal< T, _deletor >::get().

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

_kt lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::getKey

(

_kt

k

)

const [inline]

using a non-const key, get the actual key

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

void lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::put	(	_kt	k,
		_vt	v
	)			[inline]

put the specified pair into the map.

remove any old items first

Parameters:

	k	the key
	v	the value

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

void lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::remove	(	_kt	key,
		const bool	dontDeleteKey = false,
		const bool	dontDeleteValue = false
	)			[inline]

delete and optionally delete the specified key and associated value

Referenced by lucene::util::ThreadLocal< T, _deletor >::set().

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

void lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::removeitr	(	iterator	itr,
		const bool	dontDeleteKey = false,
		const bool	dontDeleteValue = false
	)			[inline]

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

void lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::setDeleteKey

(

bool

val

)

[inline]

template<typename _kt , typename _vt , typename _base , typename _KeyDeletor = lucene:: util ::Deletor::Dummy, typename _ValueDeletor = lucene:: util ::Deletor::Dummy>

void lucene::util::__CLMap< _kt, _vt, _base, _KeyDeletor, _ValueDeletor >::setDeleteValue

(

bool

val

)

[inline]

---

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

• VoidMap.h