blob: e6ace13b18b96bef0c8b5a46ab2e186ef3135b12 [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 Sat May 17 12:14:25 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ConfigurationBuilder (Apache Felix iPOJO ~ JavaDoc 1.12.0 API)</title>
<meta name="date" content="2014-05-17">
<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="ConfigurationBuilder (Apache Felix iPOJO ~ JavaDoc 1.12.0 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/ConfigurationBuilder.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>Prev Class</li>
<li><a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/extender/ConfigurationBuilder.html" target="_top">Frames</a></li>
<li><a href="ConfigurationBuilder.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.felix.ipojo.extender</div>
<h2 title="Interface ConfigurationBuilder" class="title">Interface ConfigurationBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/felix/ipojo/extender/internal/declaration/service/DefaultConfigurationBuilder.html" title="class in org.apache.felix.ipojo.extender.internal.declaration.service">DefaultConfigurationBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/felix/ipojo/extender/ConfigurationBuilder.html#line.29">ConfigurationBuilder</a></pre>
<div class="block">Support class for fluent instance declaration building.
This class can be used to provide values for instance configuration.
Any object can be used as configuration values (List and Maps are accepted for example).</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.11.2</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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/extender/DeclarationHandle.html" title="interface in org.apache.felix.ipojo.extender">DeclarationHandle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html#build()">build</a></strong>()</code>
<div class="block">Build the declaration handle (contains the instance configuration).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html" title="interface in org.apache.felix.ipojo.extender">ConfigurationBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html#clear()">clear</a></strong>()</code>
<div class="block">Remove all properties from the configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html" title="interface in org.apache.felix.ipojo.extender">ConfigurationBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html#property(java.lang.String, java.lang.Object)">property</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">Provide a property value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html" title="interface in org.apache.felix.ipojo.extender">ConfigurationBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html#remove(java.lang.String)">remove</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">Remove a property from the configuration.</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="property(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>property</h4>
<pre><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html" title="interface in org.apache.felix.ipojo.extender">ConfigurationBuilder</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/ConfigurationBuilder.html#line.37">property</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">Provide a property value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - property name</dd><dd><code>value</code> - property value</dd>
<dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl>
</li>
</ul>
<a name="remove(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html" title="interface in org.apache.felix.ipojo.extender">ConfigurationBuilder</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/ConfigurationBuilder.html#line.45">remove</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">Remove a property from the configuration.
This does not affect already created declarations (from this builder).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - property name</dd>
<dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre><a href="../../../../../org/apache/felix/ipojo/extender/ConfigurationBuilder.html" title="interface in org.apache.felix.ipojo.extender">ConfigurationBuilder</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/ConfigurationBuilder.html#line.52">clear</a>()</pre>
<div class="block">Remove all properties from the configuration.
This does not affect already created declarations (from this builder).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl>
</li>
</ul>
<a name="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../../org/apache/felix/ipojo/extender/DeclarationHandle.html" title="interface in org.apache.felix.ipojo.extender">DeclarationHandle</a>&nbsp;<a href="../../../../../src-html/org/apache/felix/ipojo/extender/ConfigurationBuilder.html#line.60">build</a>()</pre>
<div class="block">Build the declaration handle (contains the instance configuration).
Notice that the declaration is not yet published (no automatic activation).
The client has to do it through <a href="../../../../../org/apache/felix/ipojo/extender/DeclarationHandle.html#publish()"><code>DeclarationHandle.publish()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the handle to the configured declaration</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/ConfigurationBuilder.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>Prev Class</li>
<li><a href="../../../../../org/apache/felix/ipojo/extender/Declaration.html" title="interface in org.apache.felix.ipojo.extender"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/felix/ipojo/extender/ConfigurationBuilder.html" target="_top">Frames</a></li>
<li><a href="ConfigurationBuilder.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All rights reserved.</small></p>
</body>
</html>