diff options
Diffstat (limited to 'comphelper/inc/comphelper/numberedcollection.hxx')
| -rw-r--r-- | comphelper/inc/comphelper/numberedcollection.hxx | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/comphelper/inc/comphelper/numberedcollection.hxx b/comphelper/inc/comphelper/numberedcollection.hxx index a955c9624518..aa0cb6f1b0bc 100644 --- a/comphelper/inc/comphelper/numberedcollection.hxx +++ b/comphelper/inc/comphelper/numberedcollection.hxx @@ -2,7 +2,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -60,12 +60,12 @@ namespace comphelper{ //_______________________________________________ // definitions -/** @short defines a collection of UNO components, where every component will get it's own unique number. +/** @short defines a collection of UNO components, where every component will get it's own unique number. @descr Such number will be unique at runtime only ... but it supports fragmentation. Note: This collection uses weak refrences only to know her components. So lifetime of thise components must be controlled outside. - + @threadsafe */ class COMPHELPER_DLLPUBLIC NumberedCollection : private ::cppu::BaseMutex @@ -74,120 +74,120 @@ class COMPHELPER_DLLPUBLIC NumberedCollection : private ::cppu::BaseMutex //------------------------------------------- // types, const private: - + struct TNumberedItem { css::uno::WeakReference< css::uno::XInterface > xItem; ::sal_Int32 nNumber; }; - - typedef ::std::hash_map< + + typedef ::std::hash_map< long , TNumberedItem , ::std::hash< long > , ::std::equal_to< long > > TNumberedItemHash; - + typedef ::std::vector< long > TDeadItemList; - + //------------------------------------------- // interface public: //--------------------------------------- /** @short lightweight constructor. - */ + */ NumberedCollection(); - + //--------------------------------------- /** @short free all internaly used resources. - */ + */ virtual ~NumberedCollection(); - + //--------------------------------------- /** set an outside component which uses this container and must be set as source of all broadcasted messages, exceptions. - + It's holded weak only so we do not need any complex dispose sessions. - + Note: Passing NULL as parameter will be allowed. It will reset the internal member reference only. - + @param xOwner the new owner of this collection. */ void setOwner (const css::uno::Reference< css::uno::XInterface >& xOwner); - + //--------------------------------------- /** set the localized prefix to be used for untitled components. - + Localization has to be done outside. This container will return those value then. There are no further checks. Its up to you to define a suitable string here :-) - + @param sPrefix the new prefix for untitled components. */ void setUntitledPrefix(const ::rtl::OUString& sPrefix); - + //--------------------------------------- /** @see css.frame.XUntitledNumbers */ virtual ::sal_Int32 SAL_CALL leaseNumber(const css::uno::Reference< css::uno::XInterface >& xComponent) throw (css::lang::IllegalArgumentException, css::uno::RuntimeException ); - + //--------------------------------------- /** @see css.frame.XUntitledNumbers */ virtual void SAL_CALL releaseNumber(::sal_Int32 nNumber) throw (css::lang::IllegalArgumentException, css::uno::RuntimeException ); - + //--------------------------------------- /** @see css.frame.XUntitledNumbers */ virtual void SAL_CALL releaseNumberForComponent(const css::uno::Reference< css::uno::XInterface >& xComponent) throw (css::lang::IllegalArgumentException, css::uno::RuntimeException ); - + //--------------------------------------- /** @see css.frame.XUntitledNumbers */ virtual ::rtl::OUString SAL_CALL getUntitledPrefix() throw (css::uno::RuntimeException); - + //------------------------------------------- // internal private: //--------------------------------------- /** @short trys to find an unique number not already used within this collection. - + @descr It reuses the smalles number which isnt used by any component of this collection. (fragmentation!) If collection is full (means there is no free number) the special value INVALID_NUMBER will be returned. - + @note Those method cant be called within a multithreaded environment .. Because such number wont be "reserved" for the calli of these method it can happen that two calls returns the same number (reasoned by the fact that first calli doesnt used the returned number already. - + So the outside code has to make sure that retrieving and using of those number will be an atomic operation. - + @return an unique number or special value INVALID_NUMBER if collection is full. - */ + */ ::sal_Int32 impl_searchFreeNumber (); - + void impl_cleanUpDeadItems ( TNumberedItemHash& lItems , const TDeadItemList& lDeadItems); - + //------------------------------------------- // member private: - + /// localized string to be used for untitled components ::rtl::OUString m_sUntitledPrefix; - + /// cache of all "leased numbers" and its bound components TNumberedItemHash m_lComponents; - + /// used as source of broadcasted messages or exceptions (can be null !) css::uno::WeakReference< css::uno::XInterface > m_xOwner; }; |