diff options
Diffstat (limited to 'latest-javadoc/com/google/inject/Provider.html')
| -rw-r--r-- | latest-javadoc/com/google/inject/Provider.html | 242 |
1 files changed, 0 insertions, 242 deletions
diff --git a/latest-javadoc/com/google/inject/Provider.html b/latest-javadoc/com/google/inject/Provider.html deleted file mode 100644 index ebeb7709..00000000 --- a/latest-javadoc/com/google/inject/Provider.html +++ /dev/null @@ -1,242 +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.6.0_07) on Wed Dec 24 20:45:47 PST 2008 --> -<TITLE> -Provider (Guice 1.0 API) -</TITLE> - -<META NAME="date" CONTENT="2008-12-24"> - -<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="Provider (Guice 1.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/ProvidedBy.html" title="annotation in com.google.inject"><B>PREV CLASS</B></A> - <A HREF="../../../com/google/inject/Provides.html" title="annotation 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/Provider.html" target="_top"><B>FRAMES</B></A> - <A HREF="Provider.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 Provider<T></H2> -<DL> -<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - the type of object this provider provides</DL> -<DL> -<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../com/google/inject/spi/ProviderWithDependencies.html" title="interface in com.google.inject.spi">ProviderWithDependencies</A><T></DD> -</DL> -<DL> -<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/google/inject/assistedinject/FactoryProvider.html" title="class in com.google.inject.assistedinject">FactoryProvider</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <B>Provider<T></B></DL> -</PRE> - -<P> -An object capable of providing instances of type <code>T</code>. Providers are used in numerous ways - by Guice: - - <ul> - <li>When the default means for obtaining instances (an injectable or parameterless constructor) - is insufficient for a particular binding, the module can specify a custom <code>Provider</code> - instead, to control exactly how Guice creates or obtains instances for the binding. - - <li>An implementation class may always choose to have a <code>Provider<T></code> instance injected, - rather than having a <code>T</code> injected directly. This may give you access to multiple - instances, instances you wish to safely mutate and discard, instances which are out of scope - (e.g. using a <code>@RequestScoped</code> object from within a <code>@SessionScoped</code> object), or - instances that will be initialized lazily. - - <li>A custom <A HREF="../../../com/google/inject/Scope.html" title="interface in com.google.inject"><CODE>Scope</CODE></A> is implemented as a decorator of <code>Provider<T></code>, which decides - when to delegate to the backing provider and when to provide the instance some other way. - - <li>The <A HREF="../../../com/google/inject/Injector.html" title="interface in com.google.inject"><CODE>Injector</CODE></A> offers access to the <code>Provider<T></code> it uses to fulfill requests - for a given key, via the <A HREF="../../../com/google/inject/Injector.html#getProvider(com.google.inject.Key)"><CODE>Injector.getProvider(com.google.inject.Key<T>)</CODE></A> methods. - </ul> -<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/Provider.html" title="type parameter in Provider">T</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/google/inject/Provider.html#get()">get</A></B>()</CODE> - -<BR> - Provides an instance of <code>T</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="get()"><!-- --></A><H3> -get</H3> -<PRE> -<A HREF="../../../com/google/inject/Provider.html" title="type parameter in Provider">T</A> <B>get</B>()</PRE> -<DL> -<DD>Provides an instance of <code>T</code>. Must never return <code>null</code>. -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/google/inject/OutOfScopeException.html" title="class in com.google.inject">OutOfScopeException</A></CODE> - when an attempt is made to access a scoped object while the scope - in question is not currently active -<DD><CODE><A HREF="../../../com/google/inject/ProvisionException.html" title="class in com.google.inject">ProvisionException</A></CODE> - if an instance cannot be provided. Such exceptions include messages - and throwables to describe why provision failed.</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/ProvidedBy.html" title="annotation in com.google.inject"><B>PREV CLASS</B></A> - <A HREF="../../../com/google/inject/Provides.html" title="annotation 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/Provider.html" target="_top"><B>FRAMES</B></A> - <A HREF="Provider.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> |