ridljar/com/sun/star/lib/util/DisposeNotifier.java

   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: DisposeNotifier.java,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 package com.sun.star.lib.util;
  32
  33 /**
  34  * Optional interface to be implemented by objects stored in a
  35  * <code>WeakMap</code>.
  36  *
  37  * @see WeakMap
  38  */
  39 public interface DisposeNotifier {
  40     /**
  41      * Adds a dispose listener, to be notified when this object is disposed.
  42      *
  43      * <p>It is unspecified what happens when the same listener is added
  44      * multiple times.</p>
  45      *
  46      * <p>It is unspecified exactly when the <code>notifyDispose</code> callback
  47      * is fired: immediately before the notifier is disposed, while it is in the
  48      * process of disposing, or some time after it got disposed.  But even if
  49      * adding a listener to an already disposed notifer, the listener must
  50      * eventually receive a <code>notifyDispose</code> callback.</p>
  51      *
  52      * @param listener a dispose listener, to be notified when this object is
  53      * disposed; must not be <code>null</code>
  54      */
  55     void addDisposeListener(DisposeListener listener);
  56 }