| <!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 Sat Sep 20 17:22:59 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Binder (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <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="Binder (Cayenne Documentation 3.1 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/Binder.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> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/di/BeforeScopeEnd.html" title="annotation in org.apache.cayenne.di"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/di/BindingBuilder.html" title="interface in org.apache.cayenne.di"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/di/Binder.html" target="_top">Frames</a></li> |
| <li><a href="Binder.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.cayenne.di</div> |
| <h2 title="Interface Binder" class="title">Interface Binder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Binder</span></pre> |
| <div class="block">An object passed to a <a href="../../../../org/apache/cayenne/di/Module.html" title="interface in org.apache.cayenne.di"><code>Module</code></a> by the DI container during initialization, that |
| provides the API for the module to bind its services to the container. Note that the |
| default <a href="../../../../org/apache/cayenne/di/Scope.html" title="interface in org.apache.cayenne.di"><code>Scope</code></a> of the bound objects is normally "singleton" and can be changed |
| to "no scope" or a custom scope via a corresponding method of a binding builder. E.g. |
| see <a href="../../../../org/apache/cayenne/di/BindingBuilder.html#in(org.apache.cayenne.di.Scope)"><code>BindingBuilder.in(Scope)</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</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"> </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><T> <a href="../../../../org/apache/cayenne/di/BindingBuilder.html" title="interface in org.apache.cayenne.di">BindingBuilder</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/di/Binder.html#bind(java.lang.Class)">bind</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> interfaceType)</code> |
| <div class="block">Starts an unnamed binding of a specific interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/cayenne/di/BindingBuilder.html" title="interface in org.apache.cayenne.di">BindingBuilder</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/di/Binder.html#bind(org.apache.cayenne.di.Key)">bind</a></strong>(<a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di">Key</a><T> key)</code> |
| <div class="block">Starts a binding of a specific interface based on a provided binding key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/di/Binder.html#bindList(java.lang.String)">bindList</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bindingName)</code> |
| <div class="block">Starts a binding of a java.util.List<?> distinguished by its binding name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/cayenne/di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/di/Binder.html#bindMap(java.lang.String)">bindMap</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bindingName)</code> |
| <div class="block">Starts a binding of a java.util.Map<String, ?> distinguished by its binding name.</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="bind(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre><T> <a href="../../../../org/apache/cayenne/di/BindingBuilder.html" title="interface in org.apache.cayenne.di">BindingBuilder</a><T> bind(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> interfaceType)</pre> |
| <div class="block">Starts an unnamed binding of a specific interface. Binding should continue using |
| returned BindingBuilder.</div> |
| </li> |
| </ul> |
| <a name="bind(org.apache.cayenne.di.Key)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre><T> <a href="../../../../org/apache/cayenne/di/BindingBuilder.html" title="interface in org.apache.cayenne.di">BindingBuilder</a><T> bind(<a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di">Key</a><T> key)</pre> |
| <div class="block">Starts a binding of a specific interface based on a provided binding key. This |
| method is more generic than <a href="../../../../org/apache/cayenne/di/Binder.html#bind(java.lang.Class)"><code>bind(Class)</code></a> and allows to create named |
| bindings in addition to default ones. Binding should continue using returned |
| BindingBuilder.</div> |
| </li> |
| </ul> |
| <a name="bindMap(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindMap</h4> |
| <pre><T> <a href="../../../../org/apache/cayenne/di/MapBuilder.html" title="interface in org.apache.cayenne.di">MapBuilder</a><T> bindMap(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bindingName)</pre> |
| <div class="block">Starts a binding of a java.util.Map<String, ?> distinguished by its binding name. |
| Map binding should continue using returned MapBuilder. This is somewhat equivalent |
| of using "bind(Map.class, bindingName)", however returned MapBuilder provides extra |
| DI capabilities.</div> |
| </li> |
| </ul> |
| <a name="bindList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>bindList</h4> |
| <pre><T> <a href="../../../../org/apache/cayenne/di/ListBuilder.html" title="interface in org.apache.cayenne.di">ListBuilder</a><T> bindList(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bindingName)</pre> |
| <div class="block">Starts a binding of a java.util.List<?> distinguished by its binding name. List |
| binding should continue using returned ListBuilder. This is somewhat equivalent of |
| using "bind(List.class, bindingName)", however returned ListBuilder provides extra |
| DI capabilities.</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="class-use/Binder.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> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/di/BeforeScopeEnd.html" title="annotation in org.apache.cayenne.di"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/di/BindingBuilder.html" title="interface in org.apache.cayenne.di"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/di/Binder.html" target="_top">Frames</a></li> |
| <li><a href="Binder.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |