Subversion Repositories SmartDukaan

Rev

Rev 156 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
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:38 EST 2010 -->
6
<TITLE>
7
ProviderMethodBinding
8
</TITLE>
9
 
10
<META NAME="keywords" CONTENT="com.google.gwt.inject.rebind.binding.ProviderMethodBinding class">
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="ProviderMethodBinding";
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>&nbsp;</TD>
38
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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
&nbsp;<A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Injectable.html" title="annotation in com.google.gwt.inject.rebind.binding"><B>PREV CLASS</B></A>&nbsp;
55
&nbsp;<A HREF="../../../../../../com/google/gwt/inject/rebind/binding/RemoteServiceProxyBinding.html" title="class in com.google.gwt.inject.rebind.binding"><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/rebind/binding/ProviderMethodBinding.html" target="_top"><B>FRAMES</B></A>  &nbsp;
58
&nbsp;<A HREF="ProviderMethodBinding.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
59
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.rebind.binding</FONT>
88
<BR>
89
Class ProviderMethodBinding</H2>
90
<PRE>
91
java.lang.Object
92
  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.gwt.inject.rebind.binding.ProviderMethodBinding</B>
93
</PRE>
94
<DL>
95
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html" title="interface in com.google.gwt.inject.rebind.binding">Binding</A></DD>
96
</DL>
97
<HR>
98
<DL>
99
<DT><PRE>public class <B>ProviderMethodBinding</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html" title="interface in com.google.gwt.inject.rebind.binding">Binding</A></DL>
100
</PRE>
101
 
102
<P>
103
A binding that calls a provider method. This binding depends on
104
 the <code>GinModule</code>'s key, meaning that it will cause the module
105
 itself to be instantiated at runtime so it can call the provider
106
 method.
107
<P>
108
 
109
<P>
110
<HR>
111
 
112
<P>
113
 
114
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
115
 
116
<A NAME="constructor_summary"><!-- --></A>
117
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120
<B>Constructor Summary</B></FONT></TH>
121
</TR>
122
<TR BGCOLOR="white" CLASS="TableRowColor">
123
<TD><CODE><B><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/ProviderMethodBinding.html#ProviderMethodBinding(com.google.gwt.inject.rebind.util.KeyUtil, com.google.gwt.inject.rebind.util.SourceWriteUtil, com.google.gwt.core.ext.TreeLogger, com.google.gwt.inject.rebind.util.NameGenerator)">ProviderMethodBinding</A></B>(<A HREF="../../../../../../com/google/gwt/inject/rebind/util/KeyUtil.html" title="class in com.google.gwt.inject.rebind.util">KeyUtil</A>&nbsp;keyUtil,
124
                      <A HREF="../../../../../../com/google/gwt/inject/rebind/util/SourceWriteUtil.html" title="class in com.google.gwt.inject.rebind.util">SourceWriteUtil</A>&nbsp;sourceWriteUtil,
125
                      com.google.gwt.core.ext.TreeLogger&nbsp;logger,
126
                      <A HREF="../../../../../../com/google/gwt/inject/rebind/util/NameGenerator.html" title="class in com.google.gwt.inject.rebind.util">NameGenerator</A>&nbsp;nameGenerator)</CODE>
127
 
128
<BR>
129
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130
</TR>
131
</TABLE>
132
&nbsp;
133
<!-- ========== METHOD SUMMARY =========== -->
134
 
135
<A NAME="method_summary"><!-- --></A>
136
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139
<B>Method Summary</B></FONT></TH>
140
</TR>
141
<TR BGCOLOR="white" CLASS="TableRowColor">
142
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143
<CODE>&nbsp;<A HREF="../../../../../../com/google/gwt/inject/rebind/binding/RequiredKeys.html" title="class in com.google.gwt.inject.rebind.binding">RequiredKeys</A></CODE></FONT></TD>
144
<TD><CODE><B><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/ProviderMethodBinding.html#getRequiredKeys()">getRequiredKeys</A></B>()</CODE>
145
 
146
<BR>
147
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148
</TR>
149
<TR BGCOLOR="white" CLASS="TableRowColor">
150
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151
<CODE>&nbsp;void</CODE></FONT></TD>
152
<TD><CODE><B><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/ProviderMethodBinding.html#setProviderMethod(com.google.inject.internal.ProviderMethod)">setProviderMethod</A></B>(<A HREF="http://google-guice.googlecode.com/svn/trunk/javadoc/com/google/inject/internal.ProviderMethod.html" title="class or interface in com.google.inject">com.google.inject.internal.ProviderMethod</A>&nbsp;providerMethod)</CODE>
153
 
154
<BR>
155
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
156
</TR>
157
<TR BGCOLOR="white" CLASS="TableRowColor">
158
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159
<CODE>&nbsp;void</CODE></FONT></TD>
160
<TD><CODE><B><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/ProviderMethodBinding.html#writeCreatorMethods(com.google.gwt.user.rebind.SourceWriter, java.lang.String)">writeCreatorMethods</A></B>(com.google.gwt.user.rebind.SourceWriter&nbsp;writer,
161
                    java.lang.String&nbsp;creatorMethodSignature)</CODE>
162
 
163
<BR>
164
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the method necessary to create the binding's type to the writer.</TD>
165
</TR>
166
</TABLE>
167
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
168
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
170
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
171
</TR>
172
<TR BGCOLOR="white" CLASS="TableRowColor">
173
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
174
</TR>
175
</TABLE>
176
&nbsp;
177
<P>
178
 
179
<!-- ========= CONSTRUCTOR DETAIL ======== -->
180
 
181
<A NAME="constructor_detail"><!-- --></A>
182
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
184
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
185
<B>Constructor Detail</B></FONT></TH>
186
</TR>
187
</TABLE>
188
 
189
<A NAME="ProviderMethodBinding(com.google.gwt.inject.rebind.util.KeyUtil, com.google.gwt.inject.rebind.util.SourceWriteUtil, com.google.gwt.core.ext.TreeLogger, com.google.gwt.inject.rebind.util.NameGenerator)"><!-- --></A><H3>
190
ProviderMethodBinding</H3>
191
<PRE>
192
<FONT SIZE="-1"><A HREF="http://google-guice.googlecode.com/svn/trunk/javadoc/com/google/inject/Inject.html" title="class or interface in com.google.inject">@Inject</A>
193
</FONT>public <B>ProviderMethodBinding</B>(<A HREF="../../../../../../com/google/gwt/inject/rebind/util/KeyUtil.html" title="class in com.google.gwt.inject.rebind.util">KeyUtil</A>&nbsp;keyUtil,
194
                                    <A HREF="../../../../../../com/google/gwt/inject/rebind/util/SourceWriteUtil.html" title="class in com.google.gwt.inject.rebind.util">SourceWriteUtil</A>&nbsp;sourceWriteUtil,
195
                                    com.google.gwt.core.ext.TreeLogger&nbsp;logger,
196
                                    <A HREF="../../../../../../com/google/gwt/inject/rebind/util/NameGenerator.html" title="class in com.google.gwt.inject.rebind.util">NameGenerator</A>&nbsp;nameGenerator)</PRE>
197
<DL>
198
</DL>
199
 
200
<!-- ============ METHOD DETAIL ========== -->
201
 
202
<A NAME="method_detail"><!-- --></A>
203
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
205
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
206
<B>Method Detail</B></FONT></TH>
207
</TR>
208
</TABLE>
209
 
210
<A NAME="setProviderMethod(com.google.inject.internal.ProviderMethod)"><!-- --></A><H3>
211
setProviderMethod</H3>
212
<PRE>
213
public void <B>setProviderMethod</B>(<A HREF="http://google-guice.googlecode.com/svn/trunk/javadoc/com/google/inject/internal.ProviderMethod.html" title="class or interface in com.google.inject">com.google.inject.internal.ProviderMethod</A>&nbsp;providerMethod)
214
                       throws com.google.gwt.core.ext.UnableToCompleteException</PRE>
215
<DL>
216
<DD><DL>
217
</DL>
218
</DD>
219
<DD><DL>
220
 
221
<DT><B>Throws:</B>
222
<DD><CODE>com.google.gwt.core.ext.UnableToCompleteException</CODE></DL>
223
</DD>
224
</DL>
225
<HR>
226
 
227
<A NAME="writeCreatorMethods(com.google.gwt.user.rebind.SourceWriter, java.lang.String)"><!-- --></A><H3>
228
writeCreatorMethods</H3>
229
<PRE>
230
public void <B>writeCreatorMethods</B>(com.google.gwt.user.rebind.SourceWriter&nbsp;writer,
231
                                java.lang.String&nbsp;creatorMethodSignature)</PRE>
232
<DL>
233
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html#writeCreatorMethods(com.google.gwt.user.rebind.SourceWriter, java.lang.String)">Binding</A></CODE></B></DD>
234
<DD>Writes the method necessary to create the binding's type to the writer.
235
 A method with the <code>creatorMethodSignature</code> <b>must</b> be written,
236
 other methods are optional.
237
<P>
238
<DD><DL>
239
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html#writeCreatorMethods(com.google.gwt.user.rebind.SourceWriter, java.lang.String)">writeCreatorMethods</A></CODE> in interface <CODE><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html" title="interface in com.google.gwt.inject.rebind.binding">Binding</A></CODE></DL>
240
</DD>
241
<DD><DL>
242
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - writer that methods are written to<DD><CODE>creatorMethodSignature</CODE> - signature of method that needs to be created</DL>
243
</DD>
244
</DL>
245
<HR>
246
 
247
<A NAME="getRequiredKeys()"><!-- --></A><H3>
248
getRequiredKeys</H3>
249
<PRE>
250
public <A HREF="../../../../../../com/google/gwt/inject/rebind/binding/RequiredKeys.html" title="class in com.google.gwt.inject.rebind.binding">RequiredKeys</A> <B>getRequiredKeys</B>()</PRE>
251
<DL>
252
<DD><DL>
253
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html#getRequiredKeys()">getRequiredKeys</A></CODE> in interface <CODE><A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Binding.html" title="interface in com.google.gwt.inject.rebind.binding">Binding</A></CODE></DL>
254
</DD>
255
<DD><DL>
256
 
257
<DT><B>Returns:</B><DD>A tuple of two sets:  One set of keys that this binding requires.
258
     This set is used to find more classes that need to be bound. The
259
     second set contains all keys that have been optionally requested.</DL>
260
</DD>
261
</DL>
262
<!-- ========= END OF CLASS DATA ========= -->
263
<HR>
264
 
265
 
266
<!-- ======= START OF BOTTOM NAVBAR ====== -->
267
<A NAME="navbar_bottom"><!-- --></A>
268
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
269
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
270
<TR>
271
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
272
<A NAME="navbar_bottom_firstrow"><!-- --></A>
273
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
274
  <TR ALIGN="center" VALIGN="top">
275
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
276
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
277
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
278
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
279
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
280
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
281
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
282
  </TR>
283
</TABLE>
284
</TD>
285
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
286
</EM>
287
</TD>
288
</TR>
289
 
290
<TR>
291
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
292
&nbsp;<A HREF="../../../../../../com/google/gwt/inject/rebind/binding/Injectable.html" title="annotation in com.google.gwt.inject.rebind.binding"><B>PREV CLASS</B></A>&nbsp;
293
&nbsp;<A HREF="../../../../../../com/google/gwt/inject/rebind/binding/RemoteServiceProxyBinding.html" title="class in com.google.gwt.inject.rebind.binding"><B>NEXT CLASS</B></A></FONT></TD>
294
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
295
  <A HREF="../../../../../../index.html?com/google/gwt/inject/rebind/binding/ProviderMethodBinding.html" target="_top"><B>FRAMES</B></A>  &nbsp;
296
&nbsp;<A HREF="ProviderMethodBinding.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
297
&nbsp;<SCRIPT type="text/javascript">
298
  <!--
299
  if(window==top) {
300
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
301
  }
302
  //-->
303
</SCRIPT>
304
<NOSCRIPT>
305
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
306
</NOSCRIPT>
307
 
308
 
309
</FONT></TD>
310
</TR>
311
<TR>
312
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
313
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
314
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
315
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
316
</TR>
317
</TABLE>
318
<A NAME="skip-navbar_bottom"></A>
319
<!-- ======== END OF BOTTOM NAVBAR ======= -->
320
 
321
<HR>
322
 
323
</BODY>
324
</HTML>