log4cplus  2.1.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
log4cplus::spi::FactoryRegistry< T > Class Template Reference

This template class is used as a "Factory Registry". More...

#include <factory.h>

Inheritance diagram for log4cplus::spi::FactoryRegistry< T >:
[legend]
Collaboration diagram for log4cplus::spi::FactoryRegistry< T >:
[legend]

Public Types

typedef T product_type
 

Public Member Functions

virtual ~FactoryRegistry ()
 
bool put (std::unique_ptr< T > object)
 Used to enter an object into the registry. More...
 
T * get (const log4cplus::tstring &name) const
 Used to retrieve an object from the registry. More...
 
- Public Member Functions inherited from log4cplus::spi::ObjectRegistryBase
bool exists (const log4cplus::tstring &name) const
 Tests to see whether or not an object is bound in the registry as name. More...
 
std::vector< log4cplus::tstringgetAllNames () const
 Returns the names of all registered objects. More...
 
void _enableLocking (bool)
 This function is internal implementation detail. More...
 

Protected Member Functions

virtual void deleteObject (void *object) const
 Deletes object. More...
 
- Protected Member Functions inherited from log4cplus::spi::ObjectRegistryBase
 ObjectRegistryBase ()
 
virtual ~ObjectRegistryBase ()
 
bool putVal (const log4cplus::tstring &name, void *object)
 Used to enter an object into the registry. More...
 
void * getVal (const log4cplus::tstring &name) const
 Used to retrieve an object from the registry. More...
 
virtual void clear ()
 Deletes all objects from this registry. More...
 

Additional Inherited Members

- Protected Types inherited from log4cplus::spi::ObjectRegistryBase
typedef std::map< log4cplus::tstring, void * > ObjectMap
 
- Protected Attributes inherited from log4cplus::spi::ObjectRegistryBase
thread::Mutex mutex
 
ObjectMap data
 

Detailed Description

template<class T>
class log4cplus::spi::FactoryRegistry< T >

This template class is used as a "Factory Registry".

Objects are "entered" into the registry with a "name" using the put() method. (The registry then owns the object.) These object can then be retrieved using the get() method.

Note: This class is Thread-safe.

Definition at line 149 of file factory.h.

Member Typedef Documentation

◆ product_type

template<class T >
typedef T log4cplus::spi::FactoryRegistry< T >::product_type

Definition at line 153 of file factory.h.

Constructor & Destructor Documentation

◆ ~FactoryRegistry()

template<class T >
virtual log4cplus::spi::FactoryRegistry< T >::~FactoryRegistry ( )
inlinevirtual

Definition at line 155 of file factory.h.

Member Function Documentation

◆ deleteObject()

template<class T >
virtual void log4cplus::spi::FactoryRegistry< T >::deleteObject ( void *  object) const
inlineprotectedvirtual

Deletes object.

Implements log4cplus::spi::ObjectRegistryBase.

Definition at line 179 of file factory.h.

◆ get()

template<class T >
T* log4cplus::spi::FactoryRegistry< T >::get ( const log4cplus::tstring name) const
inline

Used to retrieve an object from the registry.

(The registry owns the returned pointer.)

Definition at line 174 of file factory.h.

◆ put()

template<class T >
bool log4cplus::spi::FactoryRegistry< T >::put ( std::unique_ptr< T >  object)
inline

Used to enter an object into the registry.

(The registry now owns object.)

Definition at line 164 of file factory.h.


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