| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:17 MSK 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Injector (cayenne-doc: Cayenne Documentation 4.0.2 API)</title> |
| <meta name="date" content="2019-10-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Injector (cayenne-doc: Cayenne Documentation 4.0.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Injector.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/Inject.html" title="annotation in org.apache.cayenne.di"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/di/Injector.html" target="_top">Frames</a></li> |
| <li><a href="Injector.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 Injector" class="title">Interface Injector</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/cayenne/di/spi/DefaultInjector.html" title="class in org.apache.cayenne.di.spi">DefaultInjector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Injector</span></pre> |
| <div class="block">A facade to the Cayenne DI container. To create an injector use <a href="../../../../org/apache/cayenne/di/DIBootstrap.html" title="class in org.apache.cayenne.di"><code>DIBootstrap</code></a> |
| static methods.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/di/Injector.html#getInstance-java.lang.Class-">getInstance</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code> |
| <div class="block">Returns a service instance bound in the container for a specific type.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/di/Injector.html#getInstance-org.apache.cayenne.di.Key-">getInstance</a></span>(<a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di">Key</a><T> key)</code> |
| <div class="block">Returns a service instance bound in the container for a specific binding key.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/cayenne/di/Provider.html" title="interface in org.apache.cayenne.di">Provider</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/di/Injector.html#getProvider-java.lang.Class-">getProvider</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/cayenne/di/Provider.html" title="interface in org.apache.cayenne.di">Provider</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/di/Injector.html#getProvider-org.apache.cayenne.di.Key-">getProvider</a></span>(<a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di">Key</a><T> key)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/di/Injector.html#injectMembers-java.lang.Object-">injectMembers</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</code> |
| <div class="block">Performs field injection on a given object, ignoring constructor injection.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/di/Injector.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">A lifecycle method that let's the injector's services to clean up their state and |
| release resources.</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="getInstance-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre><T> T getInstance(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type) |
| throws <a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></pre> |
| <div class="block">Returns a service instance bound in the container for a specific type. Throws |
| <a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di"><code>DIRuntimeException</code></a> if the type is not bound, or an instance can not be |
| created.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstance-org.apache.cayenne.di.Key-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre><T> T getInstance(<a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di">Key</a><T> key) |
| throws <a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></pre> |
| <div class="block">Returns a service instance bound in the container for a specific binding key. |
| Throws <a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di"><code>DIRuntimeException</code></a> if the key is not bound, or an instance can |
| not be created.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProvider-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProvider</h4> |
| <pre><T> <a href="../../../../org/apache/cayenne/di/Provider.html" title="interface in org.apache.cayenne.di">Provider</a><T> getProvider(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type) |
| throws <a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProvider-org.apache.cayenne.di.Key-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProvider</h4> |
| <pre><T> <a href="../../../../org/apache/cayenne/di/Provider.html" title="interface in org.apache.cayenne.di">Provider</a><T> getProvider(<a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di">Key</a><T> key) |
| throws <a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/di/DIRuntimeException.html" title="class in org.apache.cayenne.di">DIRuntimeException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="injectMembers-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectMembers</h4> |
| <pre>void injectMembers(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</pre> |
| <div class="block">Performs field injection on a given object, ignoring constructor injection. Since |
| Cayenne DI injector returns fully injected objects, this method is rarely used |
| directly. |
| <p> |
| Note that using this method inside a custom DI <a href="../../../../org/apache/cayenne/di/Provider.html" title="interface in org.apache.cayenne.di"><code>Provider</code></a> will most likely |
| result in double injection, as custom provider is wrapped in a field-injecting |
| provider by the DI container. Instead custom providers must initialize object |
| properties manually, obtaining dependencies from Injector.</div> |
| </li> |
| </ul> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>void shutdown()</pre> |
| <div class="block">A lifecycle method that let's the injector's services to clean up their state and |
| release resources. This method would normally generate a scope end event for the |
| injector's one and only singleton scope.</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Injector.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/Inject.html" title="annotation in org.apache.cayenne.di"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/di/Key.html" title="class in org.apache.cayenne.di"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/di/Injector.html" target="_top">Frames</a></li> |
| <li><a href="Injector.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–2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
