blob: b78f25e57279fed84c325f8097909f854bc2302e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
/*******************************************************************************
* Copyright (c) 2005 IBM Corporation.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.ds.tracker;
import org.osgi.framework.Bundle;
/**
* The <tt>BundleTrackerCustomizer</tt> interface allows a
* <tt>BundleTracker</tt> object to customize the bundle objects that are
* tracked. The <tt>BundleTrackerCustomizer</tt> object is called when a
* bundle is being added to the <tt>BundleTracker</tt> object. The
* <tt>BundleTrackerCustomizer</tt> can then return an object for the tracked
* bundle. The <tt>BundleTrackerCustomizer</tt> object is also called when a
* tracked bundle has been removed from the <tt>BundleTracker</tt> object.
*
* <p>
* The methods in this interface may be called as the result of a
* <tt>BundleEvent</tt> being received by a <tt>BundleTracker</tt> object.
* Since <tt>BundleEvent</tt> s are synchronously received by the
* <tt>BundleTracker</tt>, it is highly recommended that implementations of
* these methods do not alter bundle states while being synchronized on any
* object.
*
* @version $Revision: 1.2 $
*/
public interface BundleTrackerCustomizer {
/**
* A bundle is being added to the <tt>BundleTracker</tt> object.
*
* <p>
* This method is called before a bundle which matched the search parameters
* of the <tt>BundleTracker</tt> object is added to it. This method should
* return the object to be tracked for this <tt>Bundle</tt> object. The
* returned object is stored in the <tt>BundleTracker</tt> object and is
* available from the <tt>getObject</tt> and <tt>getObjects</tt>
* methods.
*
* @param bundle Bundle being added to the <tt>BundleTracker</tt> object.
* @return The object to be tracked for the <tt>Bundle</tt> object or
* <tt>null</tt> if the <tt>Bundle</tt> object should not be
* tracked.
*/
public abstract Object addingBundle(Bundle bundle);
/**
* A bundle tracked by the <tt>BundleTracker</tt> object has been
* modified.
*
* <p>
* This method is called when a bundle being tracked by the
* <tt>BundleTracker</tt> object has had its state modified.
*
* @param bundle Bundle whose state has been modified.
* @param object The object for the modified bundle.
*/
public abstract void modifiedBundle(Bundle bundle, Object object);
/**
* A bundle tracked by the <tt>BundleTracker</tt> object has been removed.
*
* <p>
* This method is called after a bundle is no longer being tracked by the
* <tt>BundleTracker</tt> object.
*
* @param bundle Bundle that has been removed.
* @param object The object for the removed bundle.
*/
public abstract void removedBundle(Bundle bundle, Object object);
}
|
