sw/inc/IInterface.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28  #ifndef IINTERFACE_HXX_INCLUDED
  29  #define IINTERFACE_HXX_INCLUDED
  30
  31  #include <sal/types.h>
  32
  33  /** The base interface
  34  */
  35  class IInterface
  36  {
  37  public:
  38
  39     /** Aquire a reference to an instance. A caller shall release
  40         the instance by calling 'release' when it is no longer needed.
  41         'acquire' and 'release' calls need to be balanced.
  42
  43         @returns
  44         the current reference count of the instance for debugging purposes.
  45     */
  46     virtual sal_Int32 acquire() = 0;
  47
  48     /** Releases a reference to an instance. A caller has to call
  49         'release' when a before aquired reference to an instance
  50         is no longer needed. 'acquire' and 'release' calls need to
  51         be balanced.
  52
  53     @returns
  54         the current reference count of the instance for debugging purposes.
  55     */
  56     virtual sal_Int32 release() = 0;
  57
  58     /** Returns the current reference count. This method should be used for
  59         debugging purposes. Using it otherwise is a signal of a design flaw.
  60     */
  61     virtual sal_Int32 getReferenceCount() const = 0;
  62
  63 protected:
  64     virtual ~IInterface() {};
  65  };
  66
  67  #endif // IDOCUMENT_HXX_INCLUDED