| <!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 Tue May 19 10:54:04 PDT 2009 --> |
| <TITLE> |
| Element (Guice 2.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-05-19"> |
| |
| <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="Element (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/spi/Dependency.html" title="class in com.google.inject.spi"><B>PREV CLASS</B></A> |
| <A HREF="../../../../com/google/inject/spi/Elements.html" title="class in com.google.inject.spi"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?com/google/inject/spi/Element.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Element.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.spi</FONT> |
| <BR> |
| Interface Element</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../com/google/inject/Binding.html" title="interface in com.google.inject">Binding</A><T>, <A HREF="../../../../com/google/inject/spi/ConstructorBinding.html" title="interface in com.google.inject.spi">ConstructorBinding</A><T>, <A HREF="../../../../com/google/inject/spi/ConvertedConstantBinding.html" title="interface in com.google.inject.spi">ConvertedConstantBinding</A><T>, <A HREF="../../../../com/google/inject/spi/ExposedBinding.html" title="interface in com.google.inject.spi">ExposedBinding</A><T>, <A HREF="../../../../com/google/inject/spi/InstanceBinding.html" title="interface in com.google.inject.spi">InstanceBinding</A><T>, <A HREF="../../../../com/google/inject/spi/LinkedKeyBinding.html" title="interface in com.google.inject.spi">LinkedKeyBinding</A><T>, <A HREF="../../../../com/google/inject/spi/PrivateElements.html" title="interface in com.google.inject.spi">PrivateElements</A>, <A HREF="../../../../com/google/inject/spi/ProviderBinding.html" title="interface in com.google.inject.spi">ProviderBinding</A><T>, <A HREF="../../../../com/google/inject/spi/ProviderInstanceBinding.html" title="interface in com.google.inject.spi">ProviderInstanceBinding</A><T>, <A HREF="../../../../com/google/inject/spi/ProviderKeyBinding.html" title="interface in com.google.inject.spi">ProviderKeyBinding</A><T>, <A HREF="../../../../com/google/inject/spi/UntargettedBinding.html" title="interface in com.google.inject.spi">UntargettedBinding</A><T></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/google/inject/spi/InjectionRequest.html" title="class in com.google.inject.spi">InjectionRequest</A>, <A HREF="../../../../com/google/inject/spi/InterceptorBinding.html" title="class in com.google.inject.spi">InterceptorBinding</A>, <A HREF="../../../../com/google/inject/spi/MembersInjectorLookup.html" title="class in com.google.inject.spi">MembersInjectorLookup</A>, <A HREF="../../../../com/google/inject/spi/Message.html" title="class in com.google.inject.spi">Message</A>, <A HREF="../../../../com/google/inject/spi/ProviderLookup.html" title="class in com.google.inject.spi">ProviderLookup</A>, <A HREF="../../../../com/google/inject/spi/ScopeBinding.html" title="class in com.google.inject.spi">ScopeBinding</A>, <A HREF="../../../../com/google/inject/spi/StaticInjectionRequest.html" title="class in com.google.inject.spi">StaticInjectionRequest</A>, <A HREF="../../../../com/google/inject/spi/TypeConverterBinding.html" title="class in com.google.inject.spi">TypeConverterBinding</A>, <A HREF="../../../../com/google/inject/spi/TypeListenerBinding.html" title="class in com.google.inject.spi">TypeListenerBinding</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>Element</B></DL> |
| </PRE> |
| |
| <P> |
| A core component of a module or injector. |
| |
| <p>The elements of a module can be inspected, validated and rewritten. Use <A HREF="../../../../com/google/inject/spi/Elements.html#getElements(com.google.inject.Module...)"><CODE>Elements.getElements()</CODE></A> to read the elements |
| from a module, and <A HREF="../../../../com/google/inject/spi/Elements.html#getModule(java.lang.Iterable)"><CODE>Elements.getModule()</CODE></A> to rewrite them. |
| This can be used for static analysis and generation of Guice modules. |
| |
| <p>The elements of an injector can be inspected and exercised. Use <A HREF="../../../../com/google/inject/Injector.html#getBindings()"><CODE>Injector.getBindings()</CODE></A> to reflect on Guice injectors. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0</DD> |
| </DL> |
| <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> |
| <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/spi/Element.html#acceptVisitor(com.google.inject.spi.ElementVisitor)">acceptVisitor</A></B>(<A HREF="../../../../com/google/inject/spi/ElementVisitor.html" title="interface in com.google.inject.spi">ElementVisitor</A><T> visitor)</CODE> |
| |
| <BR> |
| Accepts an element visitor.</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/spi/Element.html#applyTo(com.google.inject.Binder)">applyTo</A></B>(<A HREF="../../../../com/google/inject/Binder.html" title="interface in com.google.inject">Binder</A> binder)</CODE> |
| |
| <BR> |
| Writes this module element to the given binder (optional operation).</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/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../com/google/inject/spi/Element.html#getSource()">getSource</A></B>()</CODE> |
| |
| <BR> |
| Returns an arbitrary object containing information about the "place" where this element was |
| configured.</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="getSource()"><!-- --></A><H3> |
| getSource</H3> |
| <PRE> |
| <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> <B>getSource</B>()</PRE> |
| <DL> |
| <DD>Returns an arbitrary object containing information about the "place" where this element was |
| configured. Used by Guice in the production of descriptive error messages. |
| |
| <p>Tools might specially handle types they know about; <code>StackTraceElement</code> is a good |
| example. Tools should simply call <code>toString()</code> on the source object if the type is |
| unfamiliar. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="acceptVisitor(com.google.inject.spi.ElementVisitor)"><!-- --></A><H3> |
| acceptVisitor</H3> |
| <PRE> |
| <T> T <B>acceptVisitor</B>(<A HREF="../../../../com/google/inject/spi/ElementVisitor.html" title="interface in com.google.inject.spi">ElementVisitor</A><T> visitor)</PRE> |
| <DL> |
| <DD>Accepts an element visitor. Invokes the visitor method specific to this element's type. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>visitor</CODE> - to call back on</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="applyTo(com.google.inject.Binder)"><!-- --></A><H3> |
| applyTo</H3> |
| <PRE> |
| void <B>applyTo</B>(<A HREF="../../../../com/google/inject/Binder.html" title="interface in com.google.inject">Binder</A> binder)</PRE> |
| <DL> |
| <DD>Writes this module element to the given binder (optional operation). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>binder</CODE> - to apply configuration element to |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the <code>applyTo</code> method is not supported by this |
| element.</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/spi/Dependency.html" title="class in com.google.inject.spi"><B>PREV CLASS</B></A> |
| <A HREF="../../../../com/google/inject/spi/Elements.html" title="class in com.google.inject.spi"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?com/google/inject/spi/Element.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Element.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> |