235 lines
		
	
	
		
			8.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
			
		
		
	
	
			235 lines
		
	
	
		
			8.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
<!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_16) on Mon Oct 12 16:11:19 PDT 2009 -->
 | 
						|
<TITLE>
 | 
						|
Provider
 | 
						|
</TITLE>
 | 
						|
 | 
						|
<META NAME="keywords" CONTENT="javax.inject.Provider interface">
 | 
						|
 | 
						|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
 | 
						|
 | 
						|
<SCRIPT type="text/javascript">
 | 
						|
function windowTitle()
 | 
						|
{
 | 
						|
    parent.document.title="Provider";
 | 
						|
}
 | 
						|
</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="../../javax/inject/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="../../javax/inject/Named.html" title="annotation in javax.inject"><B>PREV CLASS</B></A> 
 | 
						|
 <A HREF="../../javax/inject/Qualifier.html" title="annotation in javax.inject"><B>NEXT CLASS</B></A></FONT></TD>
 | 
						|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 | 
						|
  <A HREF="../../index.html?javax/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">
 | 
						|
javax.inject</FONT>
 | 
						|
<BR>
 | 
						|
Interface Provider<T></H2>
 | 
						|
<HR>
 | 
						|
<DL>
 | 
						|
<DT><PRE>public interface <B>Provider<T></B></DL>
 | 
						|
</PRE>
 | 
						|
 | 
						|
<P>
 | 
						|
Provides instances of <code>T</code>. Typically implemented by an injector. For
 | 
						|
 any type <code>T</code> that can be injected, you can also inject
 | 
						|
 <code>Provider<T></code>. Compared to injecting <code>T</code> directly, injecting
 | 
						|
 <code>Provider<T></code> enables:
 | 
						|
 | 
						|
 <ul>
 | 
						|
   <li>retrieving multiple instances.</li>
 | 
						|
   <li>lazy or optional retrieval of an instance.</li>
 | 
						|
   <li>breaking circular dependencies.</li>
 | 
						|
   <li>abstracting scope so you can look up an instance in a smaller scope
 | 
						|
      from an instance in a containing scope.</li>
 | 
						|
 </ul>
 | 
						|
 | 
						|
 <p>For example:
 | 
						|
 | 
						|
 <pre>
 | 
						|
   class Car {
 | 
						|
     @Inject Car(Provider<Seat> seatProvider) {
 | 
						|
       Seat driver = seatProvider.get();
 | 
						|
       Seat passenger = seatProvider.get();
 | 
						|
       ...
 | 
						|
     }
 | 
						|
   }</pre>
 | 
						|
<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="../../javax/inject/Provider.html" title="type parameter in Provider">T</A></CODE></FONT></TD>
 | 
						|
<TD><CODE><B><A HREF="../../javax/inject/Provider.html#get()">get</A></B>()</CODE>
 | 
						|
 | 
						|
<BR>
 | 
						|
          Provides a fully-constructed and injected 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="../../javax/inject/Provider.html" title="type parameter in Provider">T</A> <B>get</B>()</PRE>
 | 
						|
<DL>
 | 
						|
<DD>Provides a fully-constructed and injected instance of <code>T</code>.
 | 
						|
<P>
 | 
						|
<DD><DL>
 | 
						|
 | 
						|
<DT><B>Throws:</B>
 | 
						|
<DD><CODE>java.lang.RuntimeException</CODE> - if the injector encounters an error while
 | 
						|
  providing an instance. For example, if an injectable member on
 | 
						|
  <code>T</code> throws an exception, the injector may wrap the exception
 | 
						|
  and throw it to the caller of <code>get()</code>. Callers should not try
 | 
						|
  to handle such exceptions as the behavior may vary across injector
 | 
						|
  implementations and even different configurations of the same injector.</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="../../javax/inject/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="../../javax/inject/Named.html" title="annotation in javax.inject"><B>PREV CLASS</B></A> 
 | 
						|
 <A HREF="../../javax/inject/Qualifier.html" title="annotation in javax.inject"><B>NEXT CLASS</B></A></FONT></TD>
 | 
						|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 | 
						|
  <A HREF="../../index.html?javax/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>
 | 
						|
<font size='-1'>Copyright (C) 2009 <a href='http://code.google.com/p/atinject/'>The JSR-330 Expert Group</a>. Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0'>Apache License</a>, Version 2.0.</font>
 | 
						|
</BODY>
 | 
						|
</HTML>
 |