xref: /AOO41X/main/ridljar/com/sun/star/lib/util/DisposeNotifier.java (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir package com.sun.star.lib.util;
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir /**
31*cdf0e10cSrcweir  * Optional interface to be implemented by objects stored in a
32*cdf0e10cSrcweir  * <code>WeakMap</code>.
33*cdf0e10cSrcweir  *
34*cdf0e10cSrcweir  * @see WeakMap
35*cdf0e10cSrcweir  */
36*cdf0e10cSrcweir public interface DisposeNotifier {
37*cdf0e10cSrcweir     /**
38*cdf0e10cSrcweir      * Adds a dispose listener, to be notified when this object is disposed.
39*cdf0e10cSrcweir      *
40*cdf0e10cSrcweir      * <p>It is unspecified what happens when the same listener is added
41*cdf0e10cSrcweir      * multiple times.</p>
42*cdf0e10cSrcweir      *
43*cdf0e10cSrcweir      * <p>It is unspecified exactly when the <code>notifyDispose</code> callback
44*cdf0e10cSrcweir      * is fired: immediately before the notifier is disposed, while it is in the
45*cdf0e10cSrcweir      * process of disposing, or some time after it got disposed.  But even if
46*cdf0e10cSrcweir      * adding a listener to an already disposed notifer, the listener must
47*cdf0e10cSrcweir      * eventually receive a <code>notifyDispose</code> callback.</p>
48*cdf0e10cSrcweir      *
49*cdf0e10cSrcweir      * @param listener a dispose listener, to be notified when this object is
50*cdf0e10cSrcweir      * disposed; must not be <code>null</code>
51*cdf0e10cSrcweir      */
52*cdf0e10cSrcweir     void addDisposeListener(DisposeListener listener);
53*cdf0e10cSrcweir }
54