blob: 7098f41cea8be85c14ec0814fc8d297504b34e75 [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 (version 1.7.0_25) on Mon Mar 31 09:56:26 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TransformedServiceReference (Apache Felix iPOJO ~ JavaDoc 1.11.2 API)</title>
<meta name="date" content="2014-03-31">
<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="TransformedServiceReference (Apache Felix iPOJO ~ JavaDoc 1.11.2 API)";
}
//-->
</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="class-use/TransformedServiceReference.html">Use</a></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>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" target="_top">Frames</a></li>
<li><a href="TransformedServiceReference.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.ipojo.dependency.interceptors</div>
<h2 title="Interface TransformedServiceReference" class="title">Interface TransformedServiceReference&lt;S&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;, <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;S&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/felix/ipojo/dependency/impl/TransformedServiceReferenceImpl.html" title="class in org.apache.felix.ipojo.dependency.impl">TransformedServiceReferenceImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.34">TransformedServiceReference</a>&lt;S&gt;
extends <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;S&gt;</pre>
<div class="block">Transformed service reference is an interface letting updating the properties of a service reference.
Transformed service reference wraps a <i>real</i> service reference and has all its properties.</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">&nbsp;</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 <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#FORBIDDEN_KEYS">FORBIDDEN_KEYS</a></strong></code>
<div class="block">These properties are cannot be removed, added or updated.</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">&nbsp;</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/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#addProperty(java.lang.String, java.lang.Object)">addProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Adds a property to the reference</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#addPropertyIfAbsent(java.lang.String, java.lang.Object)">addPropertyIfAbsent</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Adds a property to the service reference if this property is not already set on the reference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#contains(java.lang.String)">contains</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Does the service reference contains the given property ?</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#get(java.lang.String)">get</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets the current value of a property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#getWrappedReference()">getWrappedReference</a></strong>()</code>
<div class="block">Gets the wrapped service reference</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#removeProperty(java.lang.String)">removeProperty</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Removes a property from the reference.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.osgi.framework.ServiceReference">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.osgi.framework.<a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a></h3>
<code><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true#compareTo(java.lang.Object)" title="class or interface in org.osgi.framework">compareTo</a>, <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true#getBundle()" title="class or interface in org.osgi.framework">getBundle</a>, <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true#getProperty(java.lang.String)" title="class or interface in org.osgi.framework">getProperty</a>, <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true#getPropertyKeys()" title="class or interface in org.osgi.framework">getPropertyKeys</a>, <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true#getUsingBundles()" title="class or interface in org.osgi.framework">getUsingBundles</a>, <a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true#isAssignableTo(org.osgi.framework.Bundle, java.lang.String)" title="class or interface in org.osgi.framework">isAssignableTo</a></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="FORBIDDEN_KEYS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FORBIDDEN_KEYS</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; <a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.39">FORBIDDEN_KEYS</a></pre>
<div class="block">These properties are cannot be removed, added or updated.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addProperty(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.52">addProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Adds a property to the reference</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the property name</dd><dd><code>value</code> - the value (must not be null)</dd>
<dt><span class="strong">Returns:</span></dt><dd>the current transformed service reference</dd></dl>
</li>
</ul>
<a name="addPropertyIfAbsent(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPropertyIfAbsent</h4>
<pre><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.60">addPropertyIfAbsent</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Adds a property to the service reference if this property is not already set on the reference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the property name</dd><dd><code>value</code> - the value</dd>
<dt><span class="strong">Returns:</span></dt><dd>the current transformed service reference</dd></dl>
</li>
</ul>
<a name="get(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.67">get</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Gets the current value of a property.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the property name</dd>
<dt><span class="strong">Returns:</span></dt><dd>the current value of the property, null if not in the properties.</dd></dl>
</li>
</ul>
<a name="removeProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeProperty</h4>
<pre><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="interface in org.apache.felix.ipojo.dependency.interceptors">TransformedServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.74">removeProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Removes a property from the reference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the property name</dd>
<dt><span class="strong">Returns:</span></dt><dd>the current transformed service reference</dd></dl>
</li>
</ul>
<a name="contains(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>boolean&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.81">contains</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Does the service reference contains the given property ?</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the property name</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether the current reference contains a property with the given name</dd></dl>
</li>
</ul>
<a name="getWrappedReference()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWrappedReference</h4>
<pre><a href="http://www.osgi.org/javadoc/r4v43/core/org/osgi/framework/ServiceReference.html?is-external=true" title="class or interface in org.osgi.framework">ServiceReference</a>&lt;<a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" title="type parameter in TransformedServiceReference">S</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html#line.87">getWrappedReference</a>()</pre>
<div class="block">Gets the wrapped service reference</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the wrapped service reference</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="class-use/TransformedServiceReference.html">Use</a></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>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/felix/ipojo/dependency/interceptors/ServiceTrackingInterceptor.html" title="interface in org.apache.felix.ipojo.dependency.interceptors"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/felix/ipojo/dependency/interceptors/TransformedServiceReference.html" target="_top">Frames</a></li>
<li><a href="TransformedServiceReference.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All rights reserved.</small></p>
</body>
</html>