| 156 |
ashish |
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
2 |
<!--NewPage-->
|
|
|
3 |
<HTML>
|
|
|
4 |
<HEAD>
|
|
|
5 |
<!-- Generated by javadoc (build 1.5.0_22) on Wed Jan 06 21:26:37 EST 2010 -->
|
|
|
6 |
<TITLE>
|
|
|
7 |
GinModule
|
|
|
8 |
</TITLE>
|
|
|
9 |
|
|
|
10 |
<META NAME="keywords" CONTENT="com.google.gwt.inject.client.GinModule interface">
|
|
|
11 |
|
|
|
12 |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
13 |
|
|
|
14 |
<SCRIPT type="text/javascript">
|
|
|
15 |
function windowTitle()
|
|
|
16 |
{
|
|
|
17 |
parent.document.title="GinModule";
|
|
|
18 |
}
|
|
|
19 |
</SCRIPT>
|
|
|
20 |
<NOSCRIPT>
|
|
|
21 |
</NOSCRIPT>
|
|
|
22 |
|
|
|
23 |
</HEAD>
|
|
|
24 |
|
|
|
25 |
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
26 |
|
|
|
27 |
|
|
|
28 |
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
29 |
<A NAME="navbar_top"><!-- --></A>
|
|
|
30 |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
|
31 |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
32 |
<TR>
|
|
|
33 |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
34 |
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
|
35 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
36 |
<TR ALIGN="center" VALIGN="top">
|
|
|
37 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
38 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
39 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
40 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
41 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
42 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
43 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
44 |
</TR>
|
|
|
45 |
</TABLE>
|
|
|
46 |
</TD>
|
|
|
47 |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
48 |
</EM>
|
|
|
49 |
</TD>
|
|
|
50 |
</TR>
|
|
|
51 |
|
|
|
52 |
<TR>
|
|
|
53 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
54 |
<A HREF="../../../../../com/google/gwt/inject/client/Ginjector.html" title="interface in com.google.gwt.inject.client"><B>PREV CLASS</B></A>
|
|
|
55 |
<A HREF="../../../../../com/google/gwt/inject/client/GinModules.html" title="annotation in com.google.gwt.inject.client"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
56 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
57 |
<A HREF="../../../../../index.html?com/google/gwt/inject/client/GinModule.html" target="_top"><B>FRAMES</B></A>
|
|
|
58 |
<A HREF="GinModule.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
59 |
<SCRIPT type="text/javascript">
|
|
|
60 |
<!--
|
|
|
61 |
if(window==top) {
|
|
|
62 |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
63 |
}
|
|
|
64 |
//-->
|
|
|
65 |
</SCRIPT>
|
|
|
66 |
<NOSCRIPT>
|
|
|
67 |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
68 |
</NOSCRIPT>
|
|
|
69 |
|
|
|
70 |
|
|
|
71 |
</FONT></TD>
|
|
|
72 |
</TR>
|
|
|
73 |
<TR>
|
|
|
74 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
75 |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
76 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
77 |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
78 |
</TR>
|
|
|
79 |
</TABLE>
|
|
|
80 |
<A NAME="skip-navbar_top"></A>
|
|
|
81 |
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
82 |
|
|
|
83 |
<HR>
|
|
|
84 |
<!-- ======== START OF CLASS DATA ======== -->
|
|
|
85 |
<H2>
|
|
|
86 |
<FONT SIZE="-1">
|
|
|
87 |
com.google.gwt.inject.client</FONT>
|
|
|
88 |
<BR>
|
|
|
89 |
Interface GinModule</H2>
|
|
|
90 |
<DL>
|
|
|
91 |
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/google/gwt/inject/client/AbstractGinModule.html" title="class in com.google.gwt.inject.client">AbstractGinModule</A></DD>
|
|
|
92 |
</DL>
|
|
|
93 |
<HR>
|
|
|
94 |
<DL>
|
|
|
95 |
<DT><PRE>public interface <B>GinModule</B></DL>
|
|
|
96 |
</PRE>
|
|
|
97 |
|
|
|
98 |
<P>
|
|
|
99 |
GIN counterpart of Guice's <code>Module</code>. A <code>GinModule</code>
|
|
|
100 |
implementation is compiled both by the regular Java compiler and
|
|
|
101 |
by the GWT compiler.
|
|
|
102 |
|
|
|
103 |
<p>The regular-compiled version is used at GWT compile time as part
|
|
|
104 |
of the implementation of the <code>Generator</code> that outputs the generated
|
|
|
105 |
<code>Ginjector</code> class. Notably, the <code>Generator</code> calls the
|
|
|
106 |
<code>configure</code> method on the module class.
|
|
|
107 |
|
|
|
108 |
<p>The GWT-compiled version is used client-side at runtime. This is
|
|
|
109 |
necessary to support provider methods. Important, the GWT client
|
|
|
110 |
code never actually calls the <code>configure</code> method on the module class
|
|
|
111 |
and it is eliminated as dead code by the compiler. So <code>configure</code>
|
|
|
112 |
needs to be GWT compilable, but the resulting code will never execute.
|
|
|
113 |
|
|
|
114 |
<p>Because <code>GinModule</code> classes need to compile as GWT code,
|
|
|
115 |
all types that modules reference must be GWT translatable. This
|
|
|
116 |
is a problem for types like <A HREF="http://google-guice.googlecode.com/svn/trunk/javadoc/com/google/inject/Key.html" title="class or interface in com.google.inject"><CODE>Key</CODE></A> and
|
|
|
117 |
<A HREF="http://google-guice.googlecode.com/svn/trunk/javadoc/com/google/inject/TypeLiteral.html" title="class or interface in com.google.inject"><CODE>TypeLiteral</CODE></A>, since they normally
|
|
|
118 |
reference <CODE>Type</CODE> instances and other untranslatable
|
|
|
119 |
things. But since the <code>configure</code> method that uses them won't actually
|
|
|
120 |
be executed, all we need is to satisfy the compiler. Thus, we can get away
|
|
|
121 |
with using <code>super-source</code> to provide dummy stubs of <code>Key</code> and
|
|
|
122 |
<code>TypeLiteral</code>.
|
|
|
123 |
<P>
|
|
|
124 |
|
|
|
125 |
<P>
|
|
|
126 |
<HR>
|
|
|
127 |
|
|
|
128 |
<P>
|
|
|
129 |
|
|
|
130 |
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
131 |
|
|
|
132 |
<A NAME="method_summary"><!-- --></A>
|
|
|
133 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
134 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
135 |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
136 |
<B>Method Summary</B></FONT></TH>
|
|
|
137 |
</TR>
|
|
|
138 |
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
139 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
140 |
<CODE> void</CODE></FONT></TD>
|
|
|
141 |
<TD><CODE><B><A HREF="../../../../../com/google/gwt/inject/client/GinModule.html#configure(com.google.gwt.inject.client.binder.GinBinder)">configure</A></B>(<A HREF="../../../../../com/google/gwt/inject/client/binder/GinBinder.html" title="interface in com.google.gwt.inject.client.binder">GinBinder</A> binder)</CODE>
|
|
|
142 |
|
|
|
143 |
<BR>
|
|
|
144 |
</TD>
|
|
|
145 |
</TR>
|
|
|
146 |
</TABLE>
|
|
|
147 |
|
|
|
148 |
<P>
|
|
|
149 |
|
|
|
150 |
<!-- ============ METHOD DETAIL ========== -->
|
|
|
151 |
|
|
|
152 |
<A NAME="method_detail"><!-- --></A>
|
|
|
153 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
154 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
155 |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
156 |
<B>Method Detail</B></FONT></TH>
|
|
|
157 |
</TR>
|
|
|
158 |
</TABLE>
|
|
|
159 |
|
|
|
160 |
<A NAME="configure(com.google.gwt.inject.client.binder.GinBinder)"><!-- --></A><H3>
|
|
|
161 |
configure</H3>
|
|
|
162 |
<PRE>
|
|
|
163 |
void <B>configure</B>(<A HREF="../../../../../com/google/gwt/inject/client/binder/GinBinder.html" title="interface in com.google.gwt.inject.client.binder">GinBinder</A> binder)</PRE>
|
|
|
164 |
<DL>
|
|
|
165 |
<DD><DL>
|
|
|
166 |
</DL>
|
|
|
167 |
</DD>
|
|
|
168 |
</DL>
|
|
|
169 |
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
170 |
<HR>
|
|
|
171 |
|
|
|
172 |
|
|
|
173 |
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
174 |
<A NAME="navbar_bottom"><!-- --></A>
|
|
|
175 |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
176 |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
177 |
<TR>
|
|
|
178 |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
179 |
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
180 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
181 |
<TR ALIGN="center" VALIGN="top">
|
|
|
182 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
183 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
184 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
185 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
186 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
187 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
188 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
189 |
</TR>
|
|
|
190 |
</TABLE>
|
|
|
191 |
</TD>
|
|
|
192 |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
193 |
</EM>
|
|
|
194 |
</TD>
|
|
|
195 |
</TR>
|
|
|
196 |
|
|
|
197 |
<TR>
|
|
|
198 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
199 |
<A HREF="../../../../../com/google/gwt/inject/client/Ginjector.html" title="interface in com.google.gwt.inject.client"><B>PREV CLASS</B></A>
|
|
|
200 |
<A HREF="../../../../../com/google/gwt/inject/client/GinModules.html" title="annotation in com.google.gwt.inject.client"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
201 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
202 |
<A HREF="../../../../../index.html?com/google/gwt/inject/client/GinModule.html" target="_top"><B>FRAMES</B></A>
|
|
|
203 |
<A HREF="GinModule.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
204 |
<SCRIPT type="text/javascript">
|
|
|
205 |
<!--
|
|
|
206 |
if(window==top) {
|
|
|
207 |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
208 |
}
|
|
|
209 |
//-->
|
|
|
210 |
</SCRIPT>
|
|
|
211 |
<NOSCRIPT>
|
|
|
212 |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
213 |
</NOSCRIPT>
|
|
|
214 |
|
|
|
215 |
|
|
|
216 |
</FONT></TD>
|
|
|
217 |
</TR>
|
|
|
218 |
<TR>
|
|
|
219 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
220 |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
221 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
222 |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
223 |
</TR>
|
|
|
224 |
</TABLE>
|
|
|
225 |
<A NAME="skip-navbar_bottom"></A>
|
|
|
226 |
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
227 |
|
|
|
228 |
<HR>
|
|
|
229 |
|
|
|
230 |
</BODY>
|
|
|
231 |
</HTML>
|