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