blob: f7645ef16e6c7579dc9b79fba36864e19027c1ce [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_172) on Mon Oct 22 18:34:41 CEST 2018 -->
<title>BundleTrackerCustomizer</title>
<meta name="date" content="2018-10-22">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BundleTrackerCustomizer";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/felix/dm/tracker/BundleTracker.html" title="class in org.apache.felix.dm.tracker"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/felix/dm/tracker/ServiceTracker.html" title="class in org.apache.felix.dm.tracker"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/dm/tracker/BundleTrackerCustomizer.html" target="_top">Frames</a></li>
<li><a href="BundleTrackerCustomizer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.felix.dm.tracker</div>
<h2 title="Interface BundleTrackerCustomizer" class="title">Interface BundleTrackerCustomizer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/felix/dm/tracker/BundleTracker.html" title="class in org.apache.felix.dm.tracker">BundleTracker</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">BundleTrackerCustomizer</span></pre>
<div class="block">The <code>BundleTrackerCustomizer</code> interface allows a
<code>BundleTracker</code> to customize the <code>Bundle</code>s that are
tracked. A <code>BundleTrackerCustomizer</code> is called when a bundle is
being added to a <code>BundleTracker</code>. The
<code>BundleTrackerCustomizer</code> can then return an object for the
tracked bundle. A <code>BundleTrackerCustomizer</code> is also called when a
tracked bundle is modified or has been removed from a
<code>BundleTracker</code>.
<p>
The methods in this interface may be called as the result of a
<code>BundleEvent</code> being received by a <code>BundleTracker</code>.
Since <code>BundleEvent</code>s are received synchronously by the
<code>BundleTracker</code>, it is highly recommended that implementations of
these methods do not alter bundle states while being synchronized on any
object.
<p>
The <code>BundleTracker</code> class is thread-safe. It does not call a
<code>BundleTrackerCustomizer</code> while holding any locks.
<code>BundleTrackerCustomizer</code> implementations must also be
thread-safe.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/tracker/BundleTrackerCustomizer.html#addedBundle-Bundle-BundleEvent-java.lang.Object-">addedBundle</a></span>(Bundle&nbsp;bundle,
BundleEvent&nbsp;event,
java.lang.Object&nbsp;object)</code>
<div class="block">marrs: A bundle has been added to the BundleTracker.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/tracker/BundleTrackerCustomizer.html#addingBundle-Bundle-BundleEvent-">addingBundle</a></span>(Bundle&nbsp;bundle,
BundleEvent&nbsp;event)</code>
<div class="block">A bundle is being added to the <code>BundleTracker</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/tracker/BundleTrackerCustomizer.html#modifiedBundle-Bundle-BundleEvent-java.lang.Object-">modifiedBundle</a></span>(Bundle&nbsp;bundle,
BundleEvent&nbsp;event,
java.lang.Object&nbsp;object)</code>
<div class="block">A bundle tracked by the <code>BundleTracker</code> has been modified.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/felix/dm/tracker/BundleTrackerCustomizer.html#removedBundle-Bundle-BundleEvent-java.lang.Object-">removedBundle</a></span>(Bundle&nbsp;bundle,
BundleEvent&nbsp;event,
java.lang.Object&nbsp;object)</code>
<div class="block">A bundle tracked by the <code>BundleTracker</code> has been removed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addingBundle-Bundle-BundleEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addingBundle</h4>
<pre>java.lang.Object&nbsp;addingBundle(Bundle&nbsp;bundle,
BundleEvent&nbsp;event)</pre>
<div class="block">A bundle is being added to the <code>BundleTracker</code>.
<p>
This method is called before a bundle which matched the search parameters
of the <code>BundleTracker</code> is added to the
<code>BundleTracker</code>. This method should return the object to be
tracked for the specified <code>Bundle</code>. The returned object is
stored in the <code>BundleTracker</code> and is available from the
<a href="../../../../../org/apache/felix/dm/tracker/BundleTracker.html#getObject-Bundle-"><code>getObject</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - The <code>Bundle</code> being added to the
<code>BundleTracker</code>.</dd>
<dd><code>event</code> - The bundle event which caused this customizer method to be
called or <code>null</code> if there is no bundle event associated
with the call to this method.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The object to be tracked for the specified <code>Bundle</code>
object or <code>null</code> if the specified <code>Bundle</code>
object should not be tracked.</dd>
</dl>
</li>
</ul>
<a name="addedBundle-Bundle-BundleEvent-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addedBundle</h4>
<pre>void&nbsp;addedBundle(Bundle&nbsp;bundle,
BundleEvent&nbsp;event,
java.lang.Object&nbsp;object)</pre>
<div class="block">marrs: A bundle has been added to the BundleTracker.</div>
</li>
</ul>
<a name="modifiedBundle-Bundle-BundleEvent-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modifiedBundle</h4>
<pre>void&nbsp;modifiedBundle(Bundle&nbsp;bundle,
BundleEvent&nbsp;event,
java.lang.Object&nbsp;object)</pre>
<div class="block">A bundle tracked by the <code>BundleTracker</code> has been modified.
<p>
This method is called when a bundle being tracked by the
<code>BundleTracker</code> has had its state modified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - The <code>Bundle</code> whose state has been modified.</dd>
<dd><code>event</code> - The bundle event which caused this customizer method to be
called or <code>null</code> if there is no bundle event associated
with the call to this method.</dd>
<dd><code>object</code> - The tracked object for the specified bundle.</dd>
</dl>
</li>
</ul>
<a name="removedBundle-Bundle-BundleEvent-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removedBundle</h4>
<pre>void&nbsp;removedBundle(Bundle&nbsp;bundle,
BundleEvent&nbsp;event,
java.lang.Object&nbsp;object)</pre>
<div class="block">A bundle tracked by the <code>BundleTracker</code> has been removed.
<p>
This method is called after a bundle is no longer being tracked by the
<code>BundleTracker</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - The <code>Bundle</code> that has been removed.</dd>
<dd><code>event</code> - The bundle event which caused this customizer method to be
called or <code>null</code> if there is no bundle event associated
with the call to this method.</dd>
<dd><code>object</code> - The tracked object for the specified bundle.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/felix/dm/tracker/BundleTracker.html" title="class in org.apache.felix.dm.tracker"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/felix/dm/tracker/ServiceTracker.html" title="class in org.apache.felix.dm.tracker"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/dm/tracker/BundleTrackerCustomizer.html" target="_top">Frames</a></li>
<li><a href="BundleTrackerCustomizer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>