| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_07) on Sun Mar 29 14:26:58 PDT 2009 --> |
| <TITLE> |
| Injector (Guice 2.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-03-29"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Injector (Guice 2.0 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../com/google/inject/Inject.html" title="annotation in com.google.inject"><B>PREV CLASS</B></A> |
| <A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?com/google/inject/Injector.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Injector.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| com.google.inject</FONT> |
| <BR> |
| Interface Injector</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>Injector</B></DL> |
| </PRE> |
| |
| <P> |
| Builds the graphs of objects that make up your application. The injector tracks the dependencies |
| for each type and uses bindings to inject them. This is the core of Guice, although you rarely |
| interact with it directly. This "behind-the-scenes" operation is what distinguishes dependency |
| injection from its cousin, the service locator pattern. |
| |
| <p>Contains several default bindings: |
| |
| <ul> |
| <li>This <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject"><CODE>Injector</CODE></A> instance itself |
| <li>A <code>Provider<T></code> for each binding of type <code>T</code> |
| <li>The <A HREF="http://java.sun.com/javase/6/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging"><CODE>Logger</CODE></A> for the class being injected |
| <li>The <A HREF="../../../com/google/inject/Stage.html" title="enum in com.google.inject"><CODE>Stage</CODE></A> in which the Injector was created |
| </ul> |
| |
| Injectors are created using the facade class <A HREF="../../../com/google/inject/Guice.html" title="class in com.google.inject"><CODE>Guice</CODE></A>. |
| |
| <p>An injector can also <A HREF="../../../com/google/inject/Injector.html#injectMembers(java.lang.Object)"><CODE>inject the dependencies</CODE></A> of |
| already-constructed instances. This can be used to interoperate with objects created by other |
| frameworks or services. |
| |
| <p>Injectors can be <A HREF="../../../com/google/inject/Injector.html#createChildInjector(java.lang.Iterable)"><CODE>hierarchical</CODE></A>. Child injectors inherit |
| the configuration of their parent injectors, but the converse does not hold. |
| |
| <p>The injector's <A HREF="../../../com/google/inject/Injector.html#getBindings()"><CODE>internal bindings</CODE></A> are available for introspection. This |
| enables tools and extensions to operate on an injector reflectively. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject">Injector</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#createChildInjector(java.lang.Iterable)">createChildInjector</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><? extends <A HREF="../../../com/google/inject/Module.html" title="interface in com.google.inject">Module</A>> modules)</CODE> |
| |
| <BR> |
| Returns a new injector that inherits all state from this injector.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject">Injector</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#createChildInjector(com.google.inject.Module...)">createChildInjector</A></B>(<A HREF="../../../com/google/inject/Module.html" title="interface in com.google.inject">Module</A>... modules)</CODE> |
| |
| <BR> |
| Returns a new injector that inherits all state from this injector.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T>></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#findBindingsByType(com.google.inject.TypeLiteral)">findBindingsByType</A></B>(<A HREF="../../../com/google/inject/TypeLiteral.html" title="class in com.google.inject">TypeLiteral</A><T> type)</CODE> |
| |
| <BR> |
| Returns all explicit bindings for <code>type</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getBinding(java.lang.Class)">getBinding</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</CODE> |
| |
| <BR> |
| Returns the binding for the given type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getBinding(com.google.inject.Key)">getBinding</A></B>(<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><T> key)</CODE> |
| |
| <BR> |
| Returns the binding for the given injection key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><?>,<A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><?>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getBindings()">getBindings</A></B>()</CODE> |
| |
| <BR> |
| Returns all explicit bindings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> T</CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getInstance(java.lang.Class)">getInstance</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</CODE> |
| |
| <BR> |
| Returns the appropriate instance for the given injection type; equivalent to <code>getProvider(type).get()</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> T</CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getInstance(com.google.inject.Key)">getInstance</A></B>(<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><T> key)</CODE> |
| |
| <BR> |
| Returns the appropriate instance for the given injection key; equivalent to <code>getProvider(key).get()</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="../../../com/google/inject/MembersInjector.html" title="interface in com.google.inject">MembersInjector</A><T></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getMembersInjector(java.lang.Class)">getMembersInjector</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</CODE> |
| |
| <BR> |
| Returns the members injector used to inject dependencies into methods and fields on instances |
| of the given type <code>T</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="../../../com/google/inject/MembersInjector.html" title="interface in com.google.inject">MembersInjector</A><T></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getMembersInjector(com.google.inject.TypeLiteral)">getMembersInjector</A></B>(<A HREF="../../../com/google/inject/TypeLiteral.html" title="class in com.google.inject">TypeLiteral</A><T> typeLiteral)</CODE> |
| |
| <BR> |
| Returns the members injector used to inject dependencies into methods and fields on instances |
| of the given type <code>T</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject">Injector</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getParent()">getParent</A></B>()</CODE> |
| |
| <BR> |
| Returns this injector's parent, or <code>null</code> if this is a top-level injector.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject">Provider</A><T></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getProvider(java.lang.Class)">getProvider</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</CODE> |
| |
| <BR> |
| Returns the provider used to obtain instances for the given type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> <A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject">Provider</A><T></CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#getProvider(com.google.inject.Key)">getProvider</A></B>(<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><T> key)</CODE> |
| |
| <BR> |
| Returns the provider used to obtain instances for the given injection key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../com/google/inject/Injector.html#injectMembers(java.lang.Object)">injectMembers</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> instance)</CODE> |
| |
| <BR> |
| Injects dependencies into the fields and methods of <code>instance</code>.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="injectMembers(java.lang.Object)"><!-- --></A><H3> |
| injectMembers</H3> |
| <PRE> |
| void <B>injectMembers</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> instance)</PRE> |
| <DL> |
| <DD>Injects dependencies into the fields and methods of <code>instance</code>. Ignores the presence or |
| absence of an injectable constructor. |
| |
| <p>Whenever Guice creates an instance, it performs this injection automatically (after first |
| performing constructor injection), so if you're able to let Guice create all your objects for |
| you, you'll never need to use this method. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instance</CODE> - to inject members on<DT><B>See Also:</B><DD><A HREF="../../../com/google/inject/Binder.html#getMembersInjector(java.lang.Class)"><CODE>for a preferred alternative that supports checks before |
| run time</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMembersInjector(com.google.inject.TypeLiteral)"><!-- --></A><H3> |
| getMembersInjector</H3> |
| <PRE> |
| <T> <A HREF="../../../com/google/inject/MembersInjector.html" title="interface in com.google.inject">MembersInjector</A><T> <B>getMembersInjector</B>(<A HREF="../../../com/google/inject/TypeLiteral.html" title="class in com.google.inject">TypeLiteral</A><T> typeLiteral)</PRE> |
| <DL> |
| <DD>Returns the members injector used to inject dependencies into methods and fields on instances |
| of the given type <code>T</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>typeLiteral</CODE> - type to get members injector for<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../com/google/inject/Binder.html#getMembersInjector(com.google.inject.TypeLiteral)"><CODE>for an alternative that offers up front error |
| detection</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMembersInjector(java.lang.Class)"><!-- --></A><H3> |
| getMembersInjector</H3> |
| <PRE> |
| <T> <A HREF="../../../com/google/inject/MembersInjector.html" title="interface in com.google.inject">MembersInjector</A><T> <B>getMembersInjector</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</PRE> |
| <DL> |
| <DD>Returns the members injector used to inject dependencies into methods and fields on instances |
| of the given type <code>T</code>. When feasible, use <A HREF="../../../com/google/inject/Binder.html#getMembersInjector(com.google.inject.TypeLiteral)"><CODE>Binder.getMembersInjector(TypeLiteral)</CODE></A> |
| instead to get increased up front error detection. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - type to get members injector for<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../com/google/inject/Binder.html#getMembersInjector(java.lang.Class)"><CODE>for an alternative that offers up front error |
| detection</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBindings()"><!-- --></A><H3> |
| getBindings</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><?>,<A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><?>> <B>getBindings</B>()</PRE> |
| <DL> |
| <DD>Returns all explicit bindings. |
| |
| <p>The returned map does not include bindings inherited from a <A HREF="../../../com/google/inject/Injector.html#getParent()"><CODE>parent |
| injector</CODE></A>, should one exist. The returned map is guaranteed to iterate (for example, with |
| its <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#entrySet()" title="class or interface in java.util"><CODE>Map.entrySet()</CODE></A> iterator) in the order of insertion. In other words, |
| the order in which bindings appear in user Modules. |
| |
| <p>This method is part of the Guice SPI and is intended for use by tools and extensions. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBinding(com.google.inject.Key)"><!-- --></A><H3> |
| getBinding</H3> |
| <PRE> |
| <T> <A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T> <B>getBinding</B>(<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><T> key)</PRE> |
| <DL> |
| <DD>Returns the binding for the given injection key. This will be an explicit bindings if the key |
| was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will |
| be created if necessary. |
| |
| <p>This method is part of the Guice SPI and is intended for use by tools and extensions. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../com/google/inject/ConfigurationException.html" title="class in com.google.inject">ConfigurationException</A></CODE> - if this injector cannot find or create the binding.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBinding(java.lang.Class)"><!-- --></A><H3> |
| getBinding</H3> |
| <PRE> |
| <T> <A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T> <B>getBinding</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</PRE> |
| <DL> |
| <DD>Returns the binding for the given type. This will be an explicit bindings if the injection key |
| was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will |
| be created if necessary. |
| |
| <p>This method is part of the Guice SPI and is intended for use by tools and extensions. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../com/google/inject/ConfigurationException.html" title="class in com.google.inject">ConfigurationException</A></CODE> - if this injector cannot find or create the binding.<DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findBindingsByType(com.google.inject.TypeLiteral)"><!-- --></A><H3> |
| findBindingsByType</H3> |
| <PRE> |
| <T> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T>> <B>findBindingsByType</B>(<A HREF="../../../com/google/inject/TypeLiteral.html" title="class in com.google.inject">TypeLiteral</A><T> type)</PRE> |
| <DL> |
| <DD>Returns all explicit bindings for <code>type</code>. |
| |
| <p>This method is part of the Guice SPI and is intended for use by tools and extensions. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProvider(com.google.inject.Key)"><!-- --></A><H3> |
| getProvider</H3> |
| <PRE> |
| <T> <A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject">Provider</A><T> <B>getProvider</B>(<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><T> key)</PRE> |
| <DL> |
| <DD>Returns the provider used to obtain instances for the given injection key. When feasible, avoid |
| using this method, in favor of having Guice inject your dependencies ahead of time. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../com/google/inject/ConfigurationException.html" title="class in com.google.inject">ConfigurationException</A></CODE> - if this injector cannot find or create the provider.<DT><B>See Also:</B><DD><A HREF="../../../com/google/inject/Binder.html#getProvider(com.google.inject.Key)"><CODE>for an alternative that offers up front error detection</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProvider(java.lang.Class)"><!-- --></A><H3> |
| getProvider</H3> |
| <PRE> |
| <T> <A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject">Provider</A><T> <B>getProvider</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</PRE> |
| <DL> |
| <DD>Returns the provider used to obtain instances for the given type. When feasible, avoid |
| using this method, in favor of having Guice inject your dependencies ahead of time. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../com/google/inject/ConfigurationException.html" title="class in com.google.inject">ConfigurationException</A></CODE> - if this injector cannot find or create the provider.<DT><B>See Also:</B><DD><A HREF="../../../com/google/inject/Binder.html#getProvider(java.lang.Class)"><CODE>for an alternative that offers up front error detection</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstance(com.google.inject.Key)"><!-- --></A><H3> |
| getInstance</H3> |
| <PRE> |
| <T> T <B>getInstance</B>(<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><T> key)</PRE> |
| <DL> |
| <DD>Returns the appropriate instance for the given injection key; equivalent to <code>getProvider(key).get()</code>. When feasible, avoid using this method, in favor of having Guice |
| inject your dependencies ahead of time. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../com/google/inject/ConfigurationException.html" title="class in com.google.inject">ConfigurationException</A></CODE> - if this injector cannot find or create the provider. |
| <DD><CODE><A HREF="../../../com/google/inject/ProvisionException.html" title="class in com.google.inject">ProvisionException</A></CODE> - if there was a runtime failure while providing an instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstance(java.lang.Class)"><!-- --></A><H3> |
| getInstance</H3> |
| <PRE> |
| <T> T <B>getInstance</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><T> type)</PRE> |
| <DL> |
| <DD>Returns the appropriate instance for the given injection type; equivalent to <code>getProvider(type).get()</code>. When feasible, avoid using this method, in favor of having Guice |
| inject your dependencies ahead of time. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../com/google/inject/ConfigurationException.html" title="class in com.google.inject">ConfigurationException</A></CODE> - if this injector cannot find or create the provider. |
| <DD><CODE><A HREF="../../../com/google/inject/ProvisionException.html" title="class in com.google.inject">ProvisionException</A></CODE> - if there was a runtime failure while providing an instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParent()"><!-- --></A><H3> |
| getParent</H3> |
| <PRE> |
| <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject">Injector</A> <B>getParent</B>()</PRE> |
| <DL> |
| <DD>Returns this injector's parent, or <code>null</code> if this is a top-level injector. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createChildInjector(java.lang.Iterable)"><!-- --></A><H3> |
| createChildInjector</H3> |
| <PRE> |
| <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject">Injector</A> <B>createChildInjector</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><? extends <A HREF="../../../com/google/inject/Module.html" title="interface in com.google.inject">Module</A>> modules)</PRE> |
| <DL> |
| <DD>Returns a new injector that inherits all state from this injector. All bindings, scopes, |
| interceptors and type converters are inherited -- they are visible to the child injector. |
| Elements of the child injector are not visible to its parent. |
| |
| <p>Just-in-time bindings created for child injectors will be created in an ancestor injector |
| whenever possible. This allows for scoped instances to be shared between injectors. Use |
| explicit bindings to prevent bindings from being shared with the parent injector. |
| |
| <p>No key may be bound by both an injector and one of its ancestors. This includes just-in-time |
| bindings. The lone exception is the key for <code>Injector.class</code>, which is bound by each |
| injector to itself. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createChildInjector(com.google.inject.Module...)"><!-- --></A><H3> |
| createChildInjector</H3> |
| <PRE> |
| <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject">Injector</A> <B>createChildInjector</B>(<A HREF="../../../com/google/inject/Module.html" title="interface in com.google.inject">Module</A>... modules)</PRE> |
| <DL> |
| <DD>Returns a new injector that inherits all state from this injector. All bindings, scopes, |
| interceptors and type converters are inherited -- they are visible to the child injector. |
| Elements of the child injector are not visible to its parent. |
| |
| <p>Just-in-time bindings created for child injectors will be created in an ancestor injector |
| whenever possible. This allows for scoped instances to be shared between injectors. Use |
| explicit bindings to prevent bindings from being shared with the parent injector. |
| |
| <p>No key may be bound by both an injector and one of its ancestors. This includes just-in-time |
| bindings. The lone exception is the key for <code>Injector.class</code>, which is bound by each |
| injector to itself. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../com/google/inject/Inject.html" title="annotation in com.google.inject"><B>PREV CLASS</B></A> |
| <A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?com/google/inject/Injector.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Injector.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
