sw/inc/IInterface.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: IInterface.hxx,v $
  10  * $Revision: 1.4 $
  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 IINTERFACE_HXX_INCLUDED
  32  #define IINTERFACE_HXX_INCLUDED
  33
  34  #include <sal/types.h>
  35
  36  /** The base interface
  37  */
  38  class IInterface
  39  {
  40  public:
  41
  42     /** Aquire a reference to an instance. A caller shall release
  43         the instance by calling 'release' when it is no longer needed.
  44         'acquire' and 'release' calls need to be balanced.
  45
  46         @returns
  47         the current reference count of the instance for debugging purposes.
  48     */
  49     virtual sal_Int32 acquire() = 0;
  50
  51     /** Releases a reference to an instance. A caller has to call
  52         'release' when a before aquired reference to an instance
  53         is no longer needed. 'acquire' and 'release' calls need to
  54         be balanced.
  55
  56     @returns
  57         the current reference count of the instance for debugging purposes.
  58     */
  59     virtual sal_Int32 release() = 0;
  60
  61     /** Returns the current reference count. This method should be used for
  62         debugging purposes. Using it otherwise is a signal of a design flaw.
  63     */
  64     virtual sal_Int32 getReferenceCount() const = 0;
  65
  66 protected:
  67     virtual ~IInterface() {};
  68  };
  69
  70  #endif // IDOCUMENT_HXX_INCLUDED