configmgr/source/inc/autoreferencemap.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: autoreferencemap.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef CONFIGMGR_AUTOREFERENCEMAP_HXX
  32 #define CONFIGMGR_AUTOREFERENCEMAP_HXX
  33
  34 #include <rtl/ref.hxx>
  35 #ifndef INCLUDED_MAP
  36 #include <map>
  37 #define INCLUDED_MAP
  38 #endif
  39
  40 namespace configmgr
  41 {
  42 //-----------------------------------------------------------------------------
  43
  44     template < class Key, class Object, class KeyCompare = std::less<Key> >
  45     class AutoReferenceMap
  46     {
  47     public:
  48         typedef std::map<Key,rtl::Reference<Object>,KeyCompare>   Map;
  49     public:
  50         AutoReferenceMap()  {}
  51         ~AutoReferenceMap() {}
  52
  53         Map copy() const
  54         {
  55             return m_aMap;
  56         }
  57         void swap(Map & _rOtherData)
  58         {
  59             m_aMap.swap( _rOtherData );
  60         }
  61         void swap(AutoReferenceMap & _rOther)
  62         {
  63             this->swap( _rOther.m_aMap );
  64         }
  65
  66
  67         bool has(Key const & _aKey) const;
  68         rtl::Reference<Object> get(Key const & _aKey) const;
  69
  70         rtl::Reference<Object> insert(Key const & _aKey, rtl::Reference<Object> const & _anEntry);
  71         rtl::Reference<Object> remove(Key const & _aKey);
  72
  73     private:
  74         rtl::Reference<Object> internalGet(Key const & _aKey) const
  75         {
  76             typename Map::const_iterator it = m_aMap.find(_aKey);
  77
  78             return it != m_aMap.end() ? it->second : rtl::Reference<Object>();
  79         }
  80
  81         rtl::Reference<Object> internalAdd(Key const & _aKey, rtl::Reference<Object> const & _aNewRef)
  82         {
  83             return m_aMap[_aKey] = _aNewRef;
  84         }
  85
  86         void internalDrop(Key const & _aKey)
  87         {
  88             m_aMap.erase(_aKey);
  89         }
  90     private:
  91         Map                 m_aMap;
  92     };
  93 //-----------------------------------------------------------------------------
  94
  95     template < class Key, class Object, class KeyCompare >
  96     bool AutoReferenceMap<Key,Object,KeyCompare>::has(Key const & _aKey) const
  97     {
  98         return internalGet(_aKey).is();
  99     }
 100 //-----------------------------------------------------------------------------
 101
 102     template < class Key, class Object, class KeyCompare >
 103     rtl::Reference<Object> AutoReferenceMap<Key,Object,KeyCompare>::get(Key const & _aKey) const
 104     {
 105         return internalGet(_aKey);
 106     }
 107 //-----------------------------------------------------------------------------
 108
 109     template < class Key, class Object, class KeyCompare >
 110     rtl::Reference<Object> AutoReferenceMap<Key,Object,KeyCompare>::insert(Key const & _aKey, rtl::Reference<Object> const & _anEntry)
 111     {
 112         rtl::Reference<Object> aRef = internalAdd(_aKey,_anEntry);
 113         return aRef;
 114
 115     }
 116 //-----------------------------------------------------------------------------
 117
 118     template < class Key, class Object, class KeyCompare >
 119     rtl::Reference<Object> AutoReferenceMap<Key,Object,KeyCompare>::remove(Key const & _aKey)
 120     {
 121         rtl::Reference<Object> aRef = internalGet(_aKey);
 122         internalDrop(_aKey);
 123         return aRef;
 124     }
 125 //-----------------------------------------------------------------------------
 126
 127 ////////////////////////////////////////////////////////////////////////////////
 128
 129 } // namespace configmgr
 130
 131 #endif
 132