1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski package com.sun.star.lib.util;
25*b1cdbd2cSJim Jagielski 
26*b1cdbd2cSJim Jagielski /**
27*b1cdbd2cSJim Jagielski  * Optional interface to be implemented by objects stored in a
28*b1cdbd2cSJim Jagielski  * <code>WeakMap</code>.
29*b1cdbd2cSJim Jagielski  *
30*b1cdbd2cSJim Jagielski  * @see WeakMap
31*b1cdbd2cSJim Jagielski  */
32*b1cdbd2cSJim Jagielski public interface DisposeNotifier {
33*b1cdbd2cSJim Jagielski     /**
34*b1cdbd2cSJim Jagielski      * Adds a dispose listener, to be notified when this object is disposed.
35*b1cdbd2cSJim Jagielski      *
36*b1cdbd2cSJim Jagielski      * <p>It is unspecified what happens when the same listener is added
37*b1cdbd2cSJim Jagielski      * multiple times.</p>
38*b1cdbd2cSJim Jagielski      *
39*b1cdbd2cSJim Jagielski      * <p>It is unspecified exactly when the <code>notifyDispose</code> callback
40*b1cdbd2cSJim Jagielski      * is fired: immediately before the notifier is disposed, while it is in the
41*b1cdbd2cSJim Jagielski      * process of disposing, or some time after it got disposed.  But even if
42*b1cdbd2cSJim Jagielski      * adding a listener to an already disposed notifer, the listener must
43*b1cdbd2cSJim Jagielski      * eventually receive a <code>notifyDispose</code> callback.</p>
44*b1cdbd2cSJim Jagielski      *
45*b1cdbd2cSJim Jagielski      * @param listener a dispose listener, to be notified when this object is
46*b1cdbd2cSJim Jagielski      * disposed; must not be <code>null</code>
47*b1cdbd2cSJim Jagielski      */
addDisposeListener(DisposeListener listener)48*b1cdbd2cSJim Jagielski     void addDisposeListener(DisposeListener listener);
49*b1cdbd2cSJim Jagielski }
50