Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/Logger.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/Logger.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/Logger.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,644 @@ +<!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 (version 1.7.0_67) on Fri Mar 06 23:13:13 CET 2015 --> +<title>Logger</title> +<meta name="date" content="2015-03-06"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Logger"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/FilterIndex.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/Logger.html" target="_top">Frames</a></li> +<li><a href="Logger.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </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</div> +<h2 title="Class Logger" class="title">Class Logger</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.felix.dm.Logger</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.EventListener, org.osgi.framework.ServiceListener</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Logger</span> +extends java.lang.Object +implements org.osgi.framework.ServiceListener</pre> +<div class="block">This class mimics the standard OSGi <tt>LogService</tt> interface. An + instance of this class is used by the dependency manager for all logging. + By default this class logs messages to standard out. The log level can be set to + control the amount of logging performed, where a higher number results in + more logging. A log level of zero turns off logging completely. + + The log levels match those specified in the OSGi Log Service. + This class also tracks log services and will use the highest ranking + log service, if present, as a back end instead of printing to standard + out. The class uses reflection to invoking the log service's method to + avoid a dependency on the log interface, which is also why it does not + actually implement <code>LogService</code>. This class is in many ways + similar to the one used in the system bundle for that same purpose.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#LOG_DEBUG">LOG_DEBUG</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#LOG_ERROR">LOG_ERROR</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#LOG_INFO">LOG_INFO</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#LOG_WARNING">LOG_WARNING</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#Logger(org.osgi.framework.BundleContext)">Logger</a></strong>(org.osgi.framework.BundleContext context)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#debug()">debug</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#debug(java.lang.String,%20java.lang.Object...)">debug</a></strong>(java.lang.String format, + java.lang.Object... params)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#debug(java.lang.String,%20java.lang.Throwable,%20java.lang.Object...)">debug</a></strong>(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#doLog(org.osgi.framework.ServiceReference,%20int,%20java.lang.String,%20java.lang.Throwable)">doLog</a></strong>(org.osgi.framework.ServiceReference sr, + int level, + java.lang.String msg, + java.lang.Throwable throwable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#err(java.lang.String,%20java.lang.Object...)">err</a></strong>(java.lang.String format, + java.lang.Object... params)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#err(java.lang.String,%20java.lang.Throwable,%20java.lang.Object...)">err</a></strong>(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#getDebugKey()">getDebugKey</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#info()">info</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#info(java.lang.String,%20java.lang.Object...)">info</a></strong>(java.lang.String format, + java.lang.Object... params)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#info(java.lang.String,%20java.lang.Throwable,%20java.lang.Object...)">info</a></strong>(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#log(int,%20java.lang.String)">log</a></strong>(int level, + java.lang.String msg)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#log(int,%20java.lang.String,%20java.lang.Throwable)">log</a></strong>(int level, + java.lang.String msg, + java.lang.Throwable throwable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#log(org.osgi.framework.ServiceReference,%20int,%20java.lang.String)">log</a></strong>(org.osgi.framework.ServiceReference sr, + int level, + java.lang.String msg)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#log(org.osgi.framework.ServiceReference,%20int,%20java.lang.String,%20java.lang.Throwable)">log</a></strong>(org.osgi.framework.ServiceReference sr, + int level, + java.lang.String msg, + java.lang.Throwable throwable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#serviceChanged(org.osgi.framework.ServiceEvent)">serviceChanged</a></strong>(org.osgi.framework.ServiceEvent event)</code> +<div class="block">This method implements the callback for the ServiceListener interface.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#setDebugKey(java.lang.String)">setDebugKey</a></strong>(java.lang.String debugKey)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#setEnabledLevel(int)">setEnabledLevel</a></strong>(int enabledLevel)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#warn(java.lang.String,%20java.lang.Object...)">warn</a></strong>(java.lang.String format, + java.lang.Object... params)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Logger.html#warn(java.lang.String,%20java.lang.Throwable,%20java.lang.Object...)">warn</a></strong>(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="LOG_ERROR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG_ERROR</h4> +<pre>public static final int LOG_ERROR</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.Logger.LOG_ERROR">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LOG_WARNING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG_WARNING</h4> +<pre>public static final int LOG_WARNING</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.Logger.LOG_WARNING">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LOG_INFO"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG_INFO</h4> +<pre>public static final int LOG_INFO</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.Logger.LOG_INFO">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LOG_DEBUG"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LOG_DEBUG</h4> +<pre>public static final int LOG_DEBUG</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.Logger.LOG_DEBUG">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Logger(org.osgi.framework.BundleContext)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Logger</h4> +<pre>public Logger(org.osgi.framework.BundleContext context)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="log(int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>log</h4> +<pre>public final void log(int level, + java.lang.String msg)</pre> +</li> +</ul> +<a name="log(int, java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>log</h4> +<pre>public final void log(int level, + java.lang.String msg, + java.lang.Throwable throwable)</pre> +</li> +</ul> +<a name="log(org.osgi.framework.ServiceReference, int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>log</h4> +<pre>public final void log(org.osgi.framework.ServiceReference sr, + int level, + java.lang.String msg)</pre> +</li> +</ul> +<a name="log(org.osgi.framework.ServiceReference, int, java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>log</h4> +<pre>public final void log(org.osgi.framework.ServiceReference sr, + int level, + java.lang.String msg, + java.lang.Throwable throwable)</pre> +</li> +</ul> +<a name="doLog(org.osgi.framework.ServiceReference, int, java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doLog</h4> +<pre>protected void doLog(org.osgi.framework.ServiceReference sr, + int level, + java.lang.String msg, + java.lang.Throwable throwable)</pre> +</li> +</ul> +<a name="serviceChanged(org.osgi.framework.ServiceEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serviceChanged</h4> +<pre>public final void serviceChanged(org.osgi.framework.ServiceEvent event)</pre> +<div class="block">This method implements the callback for the ServiceListener interface. + It is public as a byproduct of implementing the interface and should + not be called directly. This method tracks run-time changes to log + service availability. If the log service being used by the framework's + logging mechanism goes away, then this will try to find an alternative. + If a higher ranking log service is registered, then this will switch + to the higher ranking log service.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>serviceChanged</code> in interface <code>org.osgi.framework.ServiceListener</code></dd> +</dl> +</li> +</ul> +<a name="setEnabledLevel(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnabledLevel</h4> +<pre>public void setEnabledLevel(int enabledLevel)</pre> +</li> +</ul> +<a name="setDebugKey(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDebugKey</h4> +<pre>public void setDebugKey(java.lang.String debugKey)</pre> +</li> +</ul> +<a name="getDebugKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDebugKey</h4> +<pre>public java.lang.String getDebugKey()</pre> +</li> +</ul> +<a name="err(java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>err</h4> +<pre>public void err(java.lang.String format, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="err(java.lang.String, java.lang.Throwable, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>err</h4> +<pre>public void err(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="warn(java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warn</h4> +<pre>public void warn(java.lang.String format, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="warn(java.lang.String, java.lang.Throwable, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warn</h4> +<pre>public void warn(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="info()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>info</h4> +<pre>public boolean info()</pre> +</li> +</ul> +<a name="info(java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>info</h4> +<pre>public void info(java.lang.String format, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="info(java.lang.String, java.lang.Throwable, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>info</h4> +<pre>public void info(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="debug()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>debug</h4> +<pre>public boolean debug()</pre> +</li> +</ul> +<a name="debug(java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>debug</h4> +<pre>public void debug(java.lang.String format, + java.lang.Object... params)</pre> +</li> +</ul> +<a name="debug(java.lang.String, java.lang.Throwable, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>debug</h4> +<pre>public void debug(java.lang.String format, + java.lang.Throwable err, + java.lang.Object... params)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/FilterIndex.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/Logger.html" target="_top">Frames</a></li> +<li><a href="Logger.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/PropertyMetaData.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/PropertyMetaData.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/PropertyMetaData.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,350 @@ +<!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 (version 1.7.0_67) on Fri Mar 06 23:13:13 CET 2015 --> +<title>PropertyMetaData</title> +<meta name="date" content="2015-03-06"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="PropertyMetaData"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Logger.html" title="class in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/PropertyMetaData.html" target="_top">Frames</a></li> +<li><a href="PropertyMetaData.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Interface PropertyMetaData" class="title">Interface PropertyMetaData</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">PropertyMetaData</span></pre> +<div class="block">This interface defines meta data regarding a given configuration property.</div> +</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#addOption(java.lang.String,%20java.lang.String)">addOption</a></strong>(java.lang.String optionLabel, + java.lang.String optionValue)</code> +<div class="block">Return a list of valid options for this property (the labels may be localized).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setCardinality(int)">setCardinality</a></strong>(int cardinality)</code> +<div class="block">Return the cardinality of this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setDefaults(java.lang.String[])">setDefaults</a></strong>(java.lang.String[] defaults)</code> +<div class="block">Returns a default for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setDescription(java.lang.String)">setDescription</a></strong>(java.lang.String description)</code> +<div class="block">Returns the property description.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setHeading(java.lang.String)">setHeading</a></strong>(java.lang.String heading)</code> +<div class="block">The label used to display the property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setId(java.lang.String)">setId</a></strong>(java.lang.String id)</code> +<div class="block">The key of a ConfigurationAdmin property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setRequired(boolean)">setRequired</a></strong>(boolean required)</code> +<div class="block">Tells if this property is required or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/PropertyMetaData.html#setType(java.lang.Class)">setType</a></strong>(java.lang.Class<?> type)</code> +<div class="block">Returns the property primitive type.</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="setHeading(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHeading</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setHeading(java.lang.String heading)</pre> +<div class="block">The label used to display the property. Example: "Log Level".</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The label used to display the property (may be localized)</dd></dl> +</li> +</ul> +<a name="setId(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setId</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setId(java.lang.String id)</pre> +<div class="block">The key of a ConfigurationAdmin property. Example: "printer.logLevel"</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The Configuration Admin property name</dd></dl> +</li> +</ul> +<a name="setType(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setType</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setType(java.lang.Class<?> type)</pre> +<div class="block">Returns the property primitive type. If must be either one of the following types:<p> + <ul> + <li>String.class</li> + <li>Long.class</li> + <li>Integer.class</li> + <li>Character.class</li> + <li>Byte.class</li> + <li>Double.class</li> + <li>Float.class</li> + <li>Boolean.class</li> + </ul></div> +</li> +</ul> +<a name="setDefaults(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaults</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setDefaults(java.lang.String[] defaults)</pre> +<div class="block">Returns a default for this property. The object must be of the appropriate type as defined by the cardinality and getType(). + The return type is a list of String objects that can be converted to the appropriate type. The cardinality of the return + array must follow the absolute cardinality of this type. E.g. if the cardinality = 0, the array must contain 1 element. + If the cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must contain from 0 to max 5 elements. Note that + the special case of a 0 cardinality, meaning a single value, does not allow arrays or vectors of 0 elements.</div> +</li> +</ul> +<a name="setDescription(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDescription</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setDescription(java.lang.String description)</pre> +<div class="block">Returns the property description. The description may be localized and must describe the semantics of this type and any + constraints. Example: "Select the log level for the Printer Service".</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a localizable description of the property.</dd></dl> +</li> +</ul> +<a name="setCardinality(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCardinality</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setCardinality(int cardinality)</pre> +<div class="block">Return the cardinality of this property. The OSGi environment handles multi valued properties in arrays ([]) or in Vector objects. + The return value is defined as follows:<p> + + <ul> + <li> x = Integer.MIN_VALUE no limit, but use Vector</li> + <li> x < 0 -x = max occurrences, store in Vector</li> + <li> x > 0 x = max occurrences, store in array []</li> + <li> x = Integer.MAX_VALUE no limit, but use array []</li> + <li> x = 0 1 occurrence required</li> + </ul></div> +</li> +</ul> +<a name="setRequired(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequired</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> setRequired(boolean required)</pre> +<div class="block">Tells if this property is required or not.</div> +</li> +</ul> +<a name="addOption(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>addOption</h4> +<pre><a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a> addOption(java.lang.String optionLabel, + java.lang.String optionValue)</pre> +<div class="block">Return a list of valid options for this property (the labels may be localized).</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the list of valid options for this property.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Logger.html" title="class in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/PropertyMetaData.html" target="_top">Frames</a></li> +<li><a href="PropertyMetaData.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/ResourceDependency.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/ResourceDependency.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/ResourceDependency.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,472 @@ +<!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 (version 1.7.0_67) on Fri Mar 06 23:13:13 CET 2015 --> +<title>ResourceDependency</title> +<meta name="date" content="2015-03-06"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ResourceDependency"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/PropertyMetaData.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/ResourceDependency.html" target="_top">Frames</a></li> +<li><a href="ResourceDependency.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Interface ResourceDependency" class="title">Interface ResourceDependency</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>, <a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceDependency</span> +extends <a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></pre> +<div class="block">A resource dependency is a dependency on a resource. A resource in this context is an object that is + identified by a URL. Resources should somehow be provided by an external component, the resource + provider. These dependencies then react on them becoming available or not. Use cases for such dependencies + are resources that are embedded in bundles, in a workspace or some remote or local repository, etc.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.felix.dm.ComponentDependencyDeclaration"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></h3> +<code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_AVAILABLE_OPTIONAL">STATE_AVAILABLE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_AVAILABLE_REQUIRED">STATE_AVAILABLE_REQUIRED</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_NAMES">STATE_NAMES</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_OPTIONAL">STATE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_REQUIRED">STATE_REQUIRED</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_UNAVAILABLE_OPTIONAL">STATE_UNAVAILABLE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_UNAVAILABLE_REQUIRED">STATE_UNAVAILABLE_REQUIRED</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.felix.dm.ResourceHandler"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></h3> +<code><a href="../../../../org/apache/felix/dm/ResourceHandler.html#FILTER">FILTER</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#HOST">HOST</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#PATH">PATH</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#PORT">PORT</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#PROTOCOL">PROTOCOL</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#URL">URL</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setAutoConfig(boolean)">setAutoConfig</a></strong>(boolean autoConfig)</code> +<div class="block">Sets auto configuration for this service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setAutoConfig(java.lang.String)">setAutoConfig</a></strong>(java.lang.String instanceName)</code> +<div class="block">Sets auto configuration for this service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks(java.lang.Object,%20java.lang.String,%20java.lang.String)">setCallbacks</a></strong>(java.lang.Object instance, + java.lang.String added, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks(java.lang.Object,%20java.lang.String,%20java.lang.String,%20java.lang.String)">setCallbacks</a></strong>(java.lang.Object instance, + java.lang.String added, + java.lang.String changed, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks(java.lang.String,%20java.lang.String)">setCallbacks</a></strong>(java.lang.String added, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks(java.lang.String,%20java.lang.String,%20java.lang.String)">setCallbacks</a></strong>(java.lang.String added, + java.lang.String changed, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setFilter(java.lang.String)">setFilter</a></strong>(java.lang.String resourceFilter)</code> +<div class="block">Sets the filter condition for this resource dependency.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setPropagate(boolean)">setPropagate</a></strong>(boolean propagate)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setPropagate(java.lang.Object,%20java.lang.String)">setPropagate</a></strong>(java.lang.Object instance, + java.lang.String method)</code> +<div class="block">Sets an Object instance and a callback method used to propagate some properties to the provided service properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setRequired(boolean)">setRequired</a></strong>(boolean required)</code> +<div class="block">Determines if this is a required dependency or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setResource(java.net.URL)">setResource</a></strong>(java.net.URL resource)</code> +<div class="block">Sets the resource for this dependency.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.dm.Dependency"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a></h3> +<code><a href="../../../../org/apache/felix/dm/Dependency.html#getAutoConfigName()">getAutoConfigName</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isAutoConfig()">isAutoConfig</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isAvailable()">isAvailable</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isPropagated()">isPropagated</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isRequired()">isRequired</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.dm.ComponentDependencyDeclaration"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></h3> +<code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getFilter()">getFilter</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getName()">getName</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getSimpleName()">getSimpleName</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getState()">getState</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getType()">getType</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.dm.ResourceHandler"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></h3> +<code><a href="../../../../org/apache/felix/dm/ResourceHandler.html#added(java.net.URL)">added</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#added(java.net.URL,%20java.util.Dictionary)">added</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed(java.net.URL)">changed</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed(java.net.URL,%20java.util.Dictionary)">changed</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed(java.net.URL)">removed</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed(java.net.URL,%20java.util.Dictionary)">removed</a></code></li> +</ul> +</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="setCallbacks(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.String added, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added or removed. When you specify callbacks, the auto configuration + feature is automatically turned off, because we're assuming you don't need it in this + case.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>added</code> - the method to call when a service was added</dd><dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency</dd></dl> +</li> +</ul> +<a name="setCallbacks(java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.String added, + java.lang.String changed, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added, changed or removed. When you specify callbacks, the auto + configuration feature is automatically turned off, because we're assuming you don't + need it in this case.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>added</code> - the method to call when a service was added</dd><dd><code>changed</code> - the method to call when a service was changed</dd><dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency</dd></dl> +</li> +</ul> +<a name="setCallbacks(java.lang.Object, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.Object instance, + java.lang.String added, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added or removed. They are called on the instance you provide. When you + specify callbacks, the auto configuration feature is automatically turned off, because + we're assuming you don't need it in this case.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the instance to call the callbacks on</dd><dd><code>added</code> - the method to call when a service was added</dd><dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency</dd></dl> +</li> +</ul> +<a name="setCallbacks(java.lang.Object, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.Object instance, + java.lang.String added, + java.lang.String changed, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added, changed or removed. They are called on the instance you provide. When you + specify callbacks, the auto configuration feature is automatically turned off, because + we're assuming you don't need it in this case.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the instance to call the callbacks on</dd><dd><code>added</code> - the method to call when a service was added</dd><dd><code>changed</code> - the method to call when a service was changed</dd><dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency</dd></dl> +</li> +</ul> +<a name="setAutoConfig(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setAutoConfig(boolean autoConfig)</pre> +<div class="block">Sets auto configuration for this service. Auto configuration allows the + dependency to fill in any attributes in the service implementation that + are of the same type as this dependency. Default is on.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>autoConfig</code> - the value of auto config</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency</dd></dl> +</li> +</ul> +<a name="setAutoConfig(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setAutoConfig(java.lang.String instanceName)</pre> +<div class="block">Sets auto configuration for this service. Auto configuration allows the + dependency to fill in the attribute in the service implementation that + has the same type and instance name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instanceName</code> - the name of attribute to auto config</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency</dd></dl> +</li> +</ul> +<a name="setResource(java.net.URL)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setResource</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setResource(java.net.URL resource)</pre> +<div class="block">Sets the resource for this dependency.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resource</code> - the URL of the resource</dd></dl> +</li> +</ul> +<a name="setRequired(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequired</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setRequired(boolean required)</pre> +<div class="block">Determines if this is a required dependency or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>required</code> - <code>true</code> if the dependency is required</dd></dl> +</li> +</ul> +<a name="setFilter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilter</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setFilter(java.lang.String resourceFilter)</pre> +<div class="block">Sets the filter condition for this resource dependency.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resourceFilter</code> - the filter condition</dd></dl> +</li> +</ul> +<a name="setPropagate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropagate</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setPropagate(boolean propagate)</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setPropagate(java.lang.Object,%20java.lang.String)"><code>setPropagate(Object, String)</code></a></dd></dl> +</li> +</ul> +<a name="setPropagate(java.lang.Object, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setPropagate</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setPropagate(java.lang.Object instance, + java.lang.String method)</pre> +<div class="block">Sets an Object instance and a callback method used to propagate some properties to the provided service properties. + The method will be invoked on the specified object instance and must have one of the following signatures:<p> + <ul><li>Dictionary callback(ServiceReference, Object service) + <li>Dictionary callback(ServiceReference) + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the Object instance which is used to retrieve propagated service properties</dd><dd><code>method</code> - the method to invoke for retrieving the properties to be propagated to the service properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>this service dependency.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/PropertyMetaData.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/ResourceDependency.html" target="_top">Frames</a></li> +<li><a href="ResourceDependency.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/ResourceHandler.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/ResourceHandler.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/4.0.0/org/apache/felix/dm/ResourceHandler.html Fri Mar 6 22:25:31 2015 @@ -0,0 +1,435 @@ +<!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 (version 1.7.0_67) on Fri Mar 06 23:13:13 CET 2015 --> +<title>ResourceHandler</title> +<meta name="date" content="2015-03-06"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ResourceHandler"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ResourceDependency.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceUtil.html" title="class in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/ResourceHandler.html" target="_top">Frames</a></li> +<li><a href="ResourceHandler.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </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</div> +<h2 title="Interface ResourceHandler" class="title">Interface ResourceHandler</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceHandler</span></pre> +<div class="block">Service interface for anybody wanting to be notified of changes to resources.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#FILTER">FILTER</a></strong></code> +<div class="block">Name of the property that's used to describe the filter condition for a resource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#HOST">HOST</a></strong></code> +<div class="block">The host part of the URL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#PATH">PATH</a></strong></code> +<div class="block">The path part of the URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#PORT">PORT</a></strong></code> +<div class="block">The port part of the URL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#PROTOCOL">PROTOCOL</a></strong></code> +<div class="block">The protocol part of the URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#URL">URL</a></strong></code> +<div class="block">Exact URL that this handler is looking for.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#added(java.net.URL)">added</a></strong>(java.net.URL resource)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Please use <a href="../../../../org/apache/felix/dm/ResourceHandler.html#added(java.net.URL,%20java.util.Dictionary)"><code>added(URL, Dictionary)</code></a> instead. When both are specified, + the new method takes precedence and the deprecated one is not invoked.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#added(java.net.URL,%20java.util.Dictionary)">added</a></strong>(java.net.URL resource, + java.util.Dictionary<?,?> resourceProperties)</code> +<div class="block">Invoked whenever a new resource is added.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed(java.net.URL)">changed</a></strong>(java.net.URL resource)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Please use <a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed(java.net.URL,%20java.util.Dictionary)"><code>changed(URL, Dictionary)</code></a> instead. When both are specified, + the new method takes precedence and the deprecated one is not invoked.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed(java.net.URL,%20java.util.Dictionary)">changed</a></strong>(java.net.URL resource, + java.util.Dictionary<?,?> resourceProperties)</code> +<div class="block">Invoked whenever an existing resource changes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed(java.net.URL)">removed</a></strong>(java.net.URL resource)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Please use <a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed(java.net.URL,%20java.util.Dictionary)"><code>removed(URL, Dictionary)</code></a> instead. When both are specified, + the new method takes precedence and the deprecated one is not invoked.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed(java.net.URL,%20java.util.Dictionary)">removed</a></strong>(java.net.URL resource, + java.util.Dictionary<?,?> resourceProperties)</code> +<div class="block">Invoked whenever an existing resource is removed.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="FILTER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FILTER</h4> +<pre>static final java.lang.String FILTER</pre> +<div class="block">Name of the property that's used to describe the filter condition for a resource.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ResourceHandler.FILTER">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="URL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>URL</h4> +<pre>static final java.lang.String URL</pre> +<div class="block">Exact URL that this handler is looking for. Can be used instead of a filter to be very explicit about the resource you're looking for.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ResourceHandler.URL">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="HOST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HOST</h4> +<pre>static final java.lang.String HOST</pre> +<div class="block">The host part of the URL.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ResourceHandler.HOST">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PATH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PATH</h4> +<pre>static final java.lang.String PATH</pre> +<div class="block">The path part of the URL.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ResourceHandler.PATH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROTOCOL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROTOCOL</h4> +<pre>static final java.lang.String PROTOCOL</pre> +<div class="block">The protocol part of the URL.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ResourceHandler.PROTOCOL">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PORT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PORT</h4> +<pre>static final java.lang.String PORT</pre> +<div class="block">The port part of the URL.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.dm.ResourceHandler.PORT">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="added(java.net.URL)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>added</h4> +<pre>void added(java.net.URL resource)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Please use <a href="../../../../org/apache/felix/dm/ResourceHandler.html#added(java.net.URL,%20java.util.Dictionary)"><code>added(URL, Dictionary)</code></a> instead. When both are specified, + the new method takes precedence and the deprecated one is not invoked.</i></div> +</li> +</ul> +<a name="added(java.net.URL, java.util.Dictionary)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>added</h4> +<pre>void added(java.net.URL resource, + java.util.Dictionary<?,?> resourceProperties)</pre> +<div class="block">Invoked whenever a new resource is added.</div> +</li> +</ul> +<a name="changed(java.net.URL)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>changed</h4> +<pre>void changed(java.net.URL resource)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Please use <a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed(java.net.URL,%20java.util.Dictionary)"><code>changed(URL, Dictionary)</code></a> instead. When both are specified, + the new method takes precedence and the deprecated one is not invoked.</i></div> +</li> +</ul> +<a name="changed(java.net.URL, java.util.Dictionary)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>changed</h4> +<pre>void changed(java.net.URL resource, + java.util.Dictionary<?,?> resourceProperties)</pre> +<div class="block">Invoked whenever an existing resource changes.</div> +</li> +</ul> +<a name="removed(java.net.URL)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removed</h4> +<pre>void removed(java.net.URL resource)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Please use <a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed(java.net.URL,%20java.util.Dictionary)"><code>removed(URL, Dictionary)</code></a> instead. When both are specified, + the new method takes precedence and the deprecated one is not invoked.</i></div> +</li> +</ul> +<a name="removed(java.net.URL, java.util.Dictionary)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removed</h4> +<pre>void removed(java.net.URL resource, + java.util.Dictionary<?,?> resourceProperties)</pre> +<div class="block">Invoked whenever an existing resource is removed.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ResourceDependency.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceUtil.html" title="class in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/felix/dm/ResourceHandler.html" target="_top">Frames</a></li> +<li><a href="ResourceHandler.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
