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

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package com.sun.star.lib.util;
  20
  21 /**
  22  * Optional interface to be implemented by objects stored in a
  23  * <code>WeakMap</code>.
  24  *
  25  * @see WeakMap
  26  */
  27 public interface DisposeNotifier {
  28     /**
  29      * Adds a dispose listener, to be notified when this object is disposed.
  30      *
  31      * <p>It is unspecified what happens when the same listener is added
  32      * multiple times.</p>
  33      *
  34      * <p>It is unspecified exactly when the <code>notifyDispose</code> callback
  35      * is fired: immediately before the notifier is disposed, while it is in the
  36      * process of disposing, or some time after it got disposed.  But even if
  37      * adding a listener to an already disposed notifier, the listener must
  38      * eventually receive a <code>notifyDispose</code> callback.</p>
  39      *
  40      * @param listener a dispose listener, to be notified when this object is
  41      * disposed; must not be <code>null</code>
  42      */
  43     void addDisposeListener(DisposeListener listener);
  44 }