diff options
Diffstat (limited to 'latest-javadoc/com/google/inject/Binding.html')
| -rw-r--r-- | latest-javadoc/com/google/inject/Binding.html | 379 |
1 files changed, 0 insertions, 379 deletions
diff --git a/latest-javadoc/com/google/inject/Binding.html b/latest-javadoc/com/google/inject/Binding.html deleted file mode 100644 index 5e2cde11..00000000 --- a/latest-javadoc/com/google/inject/Binding.html +++ /dev/null @@ -1,379 +0,0 @@ -<!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.5.0_13) on Sat Aug 02 11:10:31 PDT 2008 --> -<TITLE> -Binding (Guice 1.0 API) -</TITLE> - -<META NAME="keywords" CONTENT="com.google.inject.Binding interface"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="Binding (Guice 1.0 API)"; -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= 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/Binder.html" title="interface in com.google.inject"><B>PREV CLASS</B></A> - <A HREF="../../../com/google/inject/Binding.ScopingVisitor.html" title="interface 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/Binding.html" target="_top"><B>FRAMES</B></A> - <A HREF="Binding.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: <A HREF="#nested_class_summary">NESTED</A> | 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 Binding<T></H2> -<DL> -<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - the bound type. The injected is always assignable to this type.</DL> -<DL> -<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../com/google/inject/spi/Element.html" title="interface in com.google.inject.spi">Element</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <B>Binding<T></B><DT>extends <A HREF="../../../com/google/inject/spi/Element.html" title="interface in com.google.inject.spi">Element</A></DL> -</PRE> - -<P> -A mapping from a key (type and optional annotation) to the strategy for getting instances of the - type. This interface is part of the introspection API and is intended primarily for use by - tools. - - <p>Bindings are created in several ways: - <ul> - <li>Explicitly in a module, via <code>bind()</code> and <code>bindConstant()</code> - statements: - <pre> - bind(Service.class).annotatedWith(Red.class).to(ServiceImpl.class); - bindConstant().annotatedWith(ServerHost.class).to(args[0]);</pre></li> - <li>Implicitly by the Injector by following a type's <A HREF="../../../com/google/inject/ImplementedBy.html" title="annotation in com.google.inject"><CODE>pointer</CODE></A> <A HREF="../../../com/google/inject/ProvidedBy.html" title="annotation in com.google.inject"><CODE>annotations</CODE></A> or by using its <A HREF="../../../com/google/inject/Inject.html" title="annotation in com.google.inject"><CODE>annotated</CODE></A> or - default constructor.</li> - <li>By converting a bound instance to a different type.</li> - <li>For <A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject"><CODE>providers</CODE></A>, by delegating to the binding for the provided type.</li> - </ul> - - - <p>They exist on both modules and on injectors, and their behaviour is different for each: - <ul> - <li><strong>Module bindings</strong> are incomplete and cannot be used to provide instances. - This is because the applicable scopes and interceptors may not be known until an injector - is created. From a tool's perspective, module bindings are like the injector's source - code. They can be inspected or rewritten, but this analysis must be done statically.</li> - <li><strong>Injector bindings</strong> are complete and valid and can be used to provide - instances. From a tools' perspective, injector bindings are like reflection for an - injector. They have full runtime information, including the complete graph of injections - necessary to satisfy a binding.</li> - </ul> -<P> - -<P> -<HR> - -<P> -<!-- ======== NESTED CLASS SUMMARY ======== --> - -<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static interface</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Binding.ScopingVisitor.html" title="interface in com.google.inject">Binding.ScopingVisitor</A><<A HREF="../../../com/google/inject/Binding.ScopingVisitor.html" title="type parameter in Binding.ScopingVisitor">V</A>></B></CODE> - -<BR> - Visits each of the strategies used to scope an injection.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static interface</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Binding.TargetVisitor.html" title="interface in com.google.inject">Binding.TargetVisitor</A><<A HREF="../../../com/google/inject/Binding.TargetVisitor.html" title="type parameter in Binding.TargetVisitor">T</A>,<A HREF="../../../com/google/inject/Binding.TargetVisitor.html" title="type parameter in Binding.TargetVisitor">V</A>></B></CODE> - -<BR> - Visits each of the strategies used to find an instance to satisfy an injection.</TD> -</TR> -</TABLE> - <A NAME="nested_classes_inherited_from_class_com.google.inject.spi.Element"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface com.google.inject.spi.<A HREF="../../../com/google/inject/spi/Element.html" title="interface in com.google.inject.spi">Element</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../../com/google/inject/spi/Element.Visitor.html" title="interface in com.google.inject.spi">Element.Visitor</A><<A HREF="../../../com/google/inject/spi/Element.Visitor.html" title="type parameter in Element.Visitor">V</A>></CODE></TD> -</TR> -</TABLE> - - -<!-- ========== 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> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> -<TR ALIGN="right" VALIGN=""> -<TD NOWRAP><FONT SIZE="-1"> -<CODE><V> V</CODE></FONT></TD> -</TR> -</TABLE> -</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Binding.html#acceptScopingVisitor(com.google.inject.Binding.ScopingVisitor)">acceptScopingVisitor</A></B>(<A HREF="../../../com/google/inject/Binding.ScopingVisitor.html" title="interface in com.google.inject">Binding.ScopingVisitor</A><V> visitor)</CODE> - -<BR> - Accepts a scoping visitor.</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><V> V</CODE></FONT></TD> -</TR> -</TABLE> -</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Binding.html#acceptTargetVisitor(com.google.inject.Binding.TargetVisitor)">acceptTargetVisitor</A></B>(<A HREF="../../../com/google/inject/Binding.TargetVisitor.html" title="interface in com.google.inject">Binding.TargetVisitor</A><? super <A HREF="../../../com/google/inject/Binding.html" title="type parameter in Binding">T</A>,V> visitor)</CODE> - -<BR> - Accepts a target visitor.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><<A HREF="../../../com/google/inject/Binding.html" title="type parameter in Binding">T</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Binding.html#getKey()">getKey</A></B>()</CODE> - -<BR> - Returns the key for this binding.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject">Provider</A><<A HREF="../../../com/google/inject/Binding.html" title="type parameter in Binding">T</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Binding.html#getProvider()">getProvider</A></B>()</CODE> - -<BR> - Returns the scoped provider guice uses to fulfill requests for this - binding.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_com.google.inject.spi.Element"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from interface com.google.inject.spi.<A HREF="../../../com/google/inject/spi/Element.html" title="interface in com.google.inject.spi">Element</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../../com/google/inject/spi/Element.html#acceptVisitor(com.google.inject.spi.Element.Visitor)">acceptVisitor</A>, <A HREF="../../../com/google/inject/spi/Element.html#getSource()">getSource</A></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="getKey()"><!-- --></A><H3> -getKey</H3> -<PRE> -<A HREF="../../../com/google/inject/Key.html" title="class in com.google.inject">Key</A><<A HREF="../../../com/google/inject/Binding.html" title="type parameter in Binding">T</A>> <B>getKey</B>()</PRE> -<DL> -<DD>Returns the key for this binding. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getProvider()"><!-- --></A><H3> -getProvider</H3> -<PRE> -<A HREF="../../../com/google/inject/Provider.html" title="interface in com.google.inject">Provider</A><<A HREF="../../../com/google/inject/Binding.html" title="type parameter in Binding">T</A>> <B>getProvider</B>()</PRE> -<DL> -<DD>Returns the scoped provider guice uses to fulfill requests for this - binding. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - when invoked on a <A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject"><CODE>Binding</CODE></A> - created via <A HREF="../../../com/google/inject/spi/Elements.html#getElements(com.google.inject.Module...)"><CODE>Elements.getElements(com.google.inject.Module...)</CODE></A>. This - method is only supported on <A HREF="../../../com/google/inject/Binding.html" title="interface in com.google.inject"><CODE>Binding</CODE></A>s returned from an injector.</DL> -</DD> -</DL> -<HR> - -<A NAME="acceptTargetVisitor(com.google.inject.Binding.TargetVisitor)"><!-- --></A><H3> -acceptTargetVisitor</H3> -<PRE> -<V> V <B>acceptTargetVisitor</B>(<A HREF="../../../com/google/inject/Binding.TargetVisitor.html" title="interface in com.google.inject">Binding.TargetVisitor</A><? super <A HREF="../../../com/google/inject/Binding.html" title="type parameter in Binding">T</A>,V> visitor)</PRE> -<DL> -<DD>Accepts a target visitor. Invokes the visitor method specific to this binding's target. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>visitor</CODE> - to call back on</DL> -</DD> -</DL> -<HR> - -<A NAME="acceptScopingVisitor(com.google.inject.Binding.ScopingVisitor)"><!-- --></A><H3> -acceptScopingVisitor</H3> -<PRE> -<V> V <B>acceptScopingVisitor</B>(<A HREF="../../../com/google/inject/Binding.ScopingVisitor.html" title="interface in com.google.inject">Binding.ScopingVisitor</A><V> visitor)</PRE> -<DL> -<DD>Accepts a scoping visitor. Invokes the visitor method specific to this binding's scoping. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>visitor</CODE> - to call back on</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/Binder.html" title="interface in com.google.inject"><B>PREV CLASS</B></A> - <A HREF="../../../com/google/inject/Binding.ScopingVisitor.html" title="interface 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/Binding.html" target="_top"><B>FRAMES</B></A> - <A HREF="Binding.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: <A HREF="#nested_class_summary">NESTED</A> | 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> |