forked from google/guice
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path1.0.xml
2095 lines (2001 loc) · 84.6 KB
/
1.0.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!-- Generated by the JDiff Javadoc doclet -->
<!-- (http://www.jdiff.org) -->
<!-- on Tue May 19 17:01:51 PDT 2009 -->
<api
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:noNamespaceSchemaLocation='api.xsd'
name="1.0"
jdversion="1.1.1">
<!-- Command line arguments = -doclet jdiff.JDiff -docletpath /Applications/bin/jdiff-1.1.1/jdiff.jar:/Applications/bin/jdiff-1.1.1/xerces.jar -d /Users/jessewilson/Guice/guice-everything/api-diffs -classpath /usr/share/ant/lib/ant-launcher.jar:/usr/share/ant/lib/ant-jai.jar:/usr/share/ant/lib/ant-jmf.jar:/usr/share/ant/lib/ant-junit.jar:/usr/share/ant/lib/ant-nodeps.jar:/usr/share/ant/lib/ant-swing.jar:/usr/share/ant/lib/ant-testutil.jar:/usr/share/ant/lib/ant-trax.jar:/usr/share/ant/lib/ant.jar:/usr/share/ant/lib/junit.jar:/usr/share/ant/lib/xercesImpl.jar:/usr/share/ant/lib/xml-apis.jar -sourcepath /Users/jessewilson/Guice/guice-everything/tags/1.0/src:/Users/jessewilson/Guice/guice-everything/tags/1.0/servlet/src:/Users/jessewilson/Guice/guice-everything/tags/1.0/spring/src:/Users/jessewilson/Guice/guice-everything/tags/1.0/struts2/plugin/src -apiname 1.0 -baseURI http://www.w3.org -apidir /Users/jessewilson/Guice/guice-everything/api-diffs -source 1.5 -->
<package name="com.google.inject">
<!-- start class com.google.inject.AbstractModule -->
<class name="AbstractModule" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Module"/>
<constructor name="AbstractModule"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="configure"
abstract="false" native="false" synchronized="true"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="builder" type="com.google.inject.Binder"/>
</method>
<method name="configure"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Configures a {@link Binder} via the exposed methods.]]>
</doc>
</method>
<method name="binder" return="com.google.inject.Binder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Gets direct access to the underlying {@code Binder}.]]>
</doc>
</method>
<method name="bindScope"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="scopeAnnotation" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[@see Binder#bindScope(Class, Scope)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[@see Binder#bind(Key)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[@see Binder#bind(TypeLiteral)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="clazz" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#bind(Class)]]>
</doc>
</method>
<method name="bindConstant" return="com.google.inject.binder.AnnotatedConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[@see Binder#bindConstant()]]>
</doc>
</method>
<method name="install"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="module" type="com.google.inject.Module"/>
<doc>
<![CDATA[@see Binder#install(Module)]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="message" type="java.lang.String"/>
<param name="arguments" type="java.lang.Object[]"/>
<doc>
<![CDATA[@see Binder#addError(String, Object[])]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="t" type="java.lang.Throwable"/>
<doc>
<![CDATA[@see Binder#addError(Throwable)]]>
</doc>
</method>
<method name="requestStaticInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="types" type="java.lang.Class[]"/>
<doc>
<![CDATA[@see Binder#requestStaticInjection(Class[])]]>
</doc>
</method>
<method name="bindInterceptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="classMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"/>
<param name="methodMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"/>
<param name="interceptors" type="MethodInterceptor[]"/>
<doc>
<![CDATA[@see Binder#bindInterceptor(com.google.inject.matcher.Matcher,
com.google.inject.matcher.Matcher,
org.aopalliance.intercept.MethodInterceptor[])]]>
</doc>
</method>
<doc>
<![CDATA[A support class for {@link Module}s which reduces repetition and results in
a more readable configuration. Simply extend this class, implement {@link
#configure()}, and call the inherited methods which mirror those found in
{@link Binder}. For example:
<pre>
import static com.google.inject.Names.named;
public class MyModule extends AbstractModule {
protected void configure() {
bind(Foo.class).to(FooImpl.class).in(Scopes.SINGLETON);
bind(BarImpl.class);
link(Bar.class).to(BarImpl.class);
bindConstant(named("port")).to(8080);
}
}
</pre>
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.AbstractModule -->
<!-- start interface com.google.inject.Binder -->
<interface name="Binder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="bindInterceptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="classMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"/>
<param name="methodMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"/>
<param name="interceptors" type="MethodInterceptor[]"/>
<doc>
<![CDATA[Binds a method interceptor to methods matched by class and method
matchers.
@param classMatcher matches classes the interceptor should apply to. For
example: {@code only(Runnable.class)}.
@param methodMatcher matches methods the interceptor should apply to. For
example: {@code annotatedWith(Transactional.class)}.
@param interceptors to bind]]>
</doc>
</method>
<method name="bindScope"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[Binds a scope to an annotation.]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Creates a binding to a key.]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Creates a binding to a type.]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Creates a binding to a type.]]>
</doc>
</method>
<method name="bindConstant" return="com.google.inject.binder.AnnotatedConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Binds a constant value to an annotation.]]>
</doc>
</method>
<method name="requestStaticInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="types" type="java.lang.Class[]"/>
<doc>
<![CDATA[Upon successful creation, the {@link Injector} will inject static fields
and methods in the given classes.
@param types for which static members will be injected]]>
</doc>
</method>
<method name="install"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="module" type="com.google.inject.Module"/>
<doc>
<![CDATA[Uses the given module to configure more bindings.]]>
</doc>
</method>
<method name="currentStage" return="com.google.inject.Stage"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the current stage.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="java.lang.String"/>
<param name="arguments" type="java.lang.Object[]"/>
<doc>
<![CDATA[Records an error message which will be presented to the user at a later
time. Unlike throwing an exception, this enable us to continue
configuring the Injector and discover more errors. Uses {@link
String#format(String, Object[])} to insert the arguments into the
message.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="t" type="java.lang.Throwable"/>
<doc>
<![CDATA[Records an exception, the full details of which will be logged, and the
message of which will be presented to the user at a later
time. If your Module calls something that you worry may fail, you should
catch the exception and pass it into this.]]>
</doc>
</method>
<doc>
<![CDATA[Collects configuration information (primarily <i>bindings</i>) which will be
used to create an {@link Injector}. Guice provides this object to your
application's {@link Module}s so they may each contribute
their own bindings.
<p>The bindings contributed by {@code Module}s define how the {@code
Injector} resolves dependencies. A {@link Key} consisting of a type
and optional annotation uniquely identifies a binding within an {@code
Injector}.
<p>You may bind from a key to:
<ul>
<li>Another binding, which this binding's key is now "aliased to"
<li>Another binding, which references a {@link Provider} for this key
<li>A preconstructed instance
<li>A preconstructed instance which should be used as the {@link Provider}
for this binding
</ul>
<p>In addition, a binding may have an associated scope, such as
{@link Scopes#SINGLETON}, and singleton bindings may specify eager or lazy
initialization.
<p>See the users' guide appendix, "How the Injector resolves injection
requests," to better understand binding resolution.
<p>After an {@code Injector} has been created, its bindings may be
examined using methods like {@link Injector#getBinding(Key)}, but this
read-only {@link Binding} type is not used when <i>creating</i> the
bindings.]]>
</doc>
</interface>
<!-- end interface com.google.inject.Binder -->
<!-- start interface com.google.inject.Binding -->
<interface name="Binding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getKey" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the key for this binding.]]>
</doc>
</method>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns an arbitrary object containing information about the "place"
where this binding was configured. Used by Guice in the production of
descriptive error messages.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the provider guice uses to fulfill requests for this binding.]]>
</doc>
</method>
<doc>
<![CDATA[A mapping from a key (type and optional annotation) to a provider of
instances of that type. This interface is part of the {@link Injector}
introspection API and is intended primary for use by tools.
@author [email protected] (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Binding -->
<!-- start class com.google.inject.BindingAnnotation -->
<class name="BindingAnnotation" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates annotations which are used for binding. Only one such annotation
may apply to a single injection point. You must also annotate binder
annotations with {@code @Retention(RUNTIME)}. For example:
<pre>
{@code @}Retention(RUNTIME)
{@code @}Target({ FIELD, PARAMETER })
{@code @}BindingAnnotation
public {@code @}interface Transactional {}
</pre>
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.BindingAnnotation -->
<!-- start class com.google.inject.CreationException -->
<class name="CreationException" extends="java.lang.RuntimeException"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="CreationException" type="java.util.Collection<com.google.inject.spi.Message>"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new exception for the given errors.]]>
</doc>
</constructor>
<method name="getMessage" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getErrorMessages" return="java.util.Collection<com.google.inject.spi.Message>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the error messages which resulted in this exception.]]>
</doc>
</method>
<doc>
<![CDATA[Thrown when errors occur while creating a {@link Injector}. Includes a list
of encountered errors. Typically, a client should catch this exception, log
it, and stop execution.
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.CreationException -->
<!-- start class com.google.inject.Guice -->
<class name="Guice" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Creates an injector for the given set of modules.
@throws CreationException from which you can retrieve the individual error
messages]]>
</doc>
</method>
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="java.lang.Iterable<com.google.inject.Module>"/>
<doc>
<![CDATA[Creates an injector for the given set of modules.
@throws CreationException from which you can retrieve the individual error
messages]]>
</doc>
</method>
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stage" type="com.google.inject.Stage"/>
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Creates an injector for the given set of modules, in a given development
stage.
@throws CreationException from which you can retrieve the individual error
messages.]]>
</doc>
</method>
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stage" type="com.google.inject.Stage"/>
<param name="modules" type="java.lang.Iterable<com.google.inject.Module>"/>
<doc>
<![CDATA[Creates an injector for the given set of modules, in a given development
stage.
@throws CreationException from which you can retrieve the individual error
messages.]]>
</doc>
</method>
<doc>
<![CDATA[The entry point to the Guice framework. Creates {@link Injector}s from
{@link Module}s.]]>
</doc>
</class>
<!-- end class com.google.inject.Guice -->
<!-- start class com.google.inject.ImplementedBy -->
<class name="ImplementedBy" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[A pointer to the default implementation of a type.
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.ImplementedBy -->
<!-- start class com.google.inject.Inject -->
<class name="Inject" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates members of your implementation class (constructors, methods
and fields) into which the {@link Injector} should inject values.
The Injector fulfills injection requests for:
<ul>
<li>Every instance it constructs. The class being constructed must have
exactly one of its constructors marked with {@code @Inject} or must have a
constructor taking no parameters. The Injector then proceeds to perform
method and field injections.
<li>Pre-constructed instances passed to {@link Injector#injectMembers},
{@link com.google.inject.binder.LinkedBindingBuilder#toInstance(Object)} and
{@link com.google.inject.binder.LinkedBindingBuilder#toProvider(Provider)}.
In this case all constructors are, of course, ignored.
<li>Static fields and methods of classes which any {@link Module} has
specifically requested static injection for, using
{@link Binder#requestStaticInjection}.
</ul>
In all cases, a member can be injected regardless of its Java access
specifier (private, default, protected, public).
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Inject -->
<!-- start interface com.google.inject.Injector -->
<interface name="Injector" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="injectMembers"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
<doc>
<![CDATA[Injects dependencies into the fields and methods of an existing object.
Does not inject the constructor.]]>
</doc>
</method>
<method name="getBindings" return="java.util.Map<com.google.inject.Key<?>, com.google.inject.Binding<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets all explicit bindings.]]>
</doc>
</method>
<method name="getBinding" return="com.google.inject.Binding<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Gets a binding for the given key.]]>
</doc>
</method>
<method name="findBindingsByType" return="java.util.List<com.google.inject.Binding<T>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Finds all bindings to the given type.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Gets the provider bound to the given key.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Gets the provider bound to the given type.]]>
</doc>
</method>
<method name="getInstance" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Gets an instance bound to the given key; equivalent to
{@code getProvider(key).get()}.]]>
</doc>
</method>
<method name="getInstance" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Gets an instance bound to the given type; equivalent to
{@code getProvider(type).get()}.]]>
</doc>
</method>
<doc>
<![CDATA[Fulfills requests for the object instances that make up your application,
always ensuring that these instances are properly injected before they are
returned. The {@code Injector} is the heart of the Guice framework,
although you don't typically interact with it directly very often. This
"behind-the-scenes" operation is what distinguishes the dependency
injection pattern from its cousin, service locator.
<p>The {@code Injector} API has a few additional features: it allows
pre-constructed instances to have their fields and methods injected and
offers programmatic introspection to support tool development.
<p>Contains several default bindings:
<ul>
<li>This {@link Injector} instance itself
<li>A {@code Provider<T>} for each binding of type {@code T}
<li>The {@link java.util.logging.Logger} for the class being injected
<li>The {@link Stage} in which the Injector was created
</ul>
Injectors are created using the facade class {@link Guice}.
@author [email protected] (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Injector -->
<!-- start class com.google.inject.Key -->
<class name="Key" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="Key" type="java.lang.Class<? extends java.lang.annotation.Annotation>"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new key. Derives the type from this class's type parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.
<p>Example usage for a binding of type {@code Foo} annotated with
{@code @Bar}:
<p>{@code new Key<Foo>(Bar.class) {}}.]]>
</doc>
</constructor>
<constructor name="Key" type="java.lang.annotation.Annotation"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new key. Derives the type from this class's type parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.
<p>Example usage for a binding of type {@code Foo} annotated with
{@code @Bar}:
<p>{@code new Key<Foo>(new Bar()) {}}.]]>
</doc>
</constructor>
<constructor name="Key"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new key. Derives the type from this class's type parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.
<p>Example usage for a binding of type {@code Foo}:
<p>{@code new Key<Foo>() {}}.]]>
</doc>
</constructor>
<method name="getTypeLiteral" return="com.google.inject.TypeLiteral<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the key type.]]>
</doc>
</method>
<method name="getAnnotationType" return="java.lang.Class<? extends java.lang.annotation.Annotation>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the annotation type.]]>
</doc>
</method>
<method name="getAnnotation" return="java.lang.annotation.Annotation"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the annotation.]]>
</doc>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Gets a key for an injection type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Gets a key for an injection type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Gets a key for an injection type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation.]]>
</doc>
</method>
<doc>
<![CDATA[Binding key consisting of an injection type and an optional annotation.
Matches the type and annotation at a point of injection.
<p>For example, {@code Key.get(Service.class, Transactional.class)} will
match:
<pre>
{@literal @}Inject
public void setService({@literal @}Transactional Service service) {
...
}
</pre>
<p>{@code Key} supports generic types via subclassing just like {@link
TypeLiteral}.
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Key -->
<!-- start interface com.google.inject.Module -->
<interface name="Module" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="configure"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<doc>
<![CDATA[Contributes bindings and other configurations to a {@code Binder}.]]>
</doc>
</method>
<doc>
<![CDATA[A module contributes configuration information, typically interface
bindings, which will be used to create an {@link Injector}. A guice-based
application is ultimately composed of little more than a set of
{@code Module}s and some bootstrapping code.
<p>Your Module classes can use a more streamlined syntax by extending
{@link AbstractModule} rather than implementing this interface directly.]]>
</doc>
</interface>
<!-- end interface com.google.inject.Module -->
<!-- start class com.google.inject.ProvidedBy -->
<class name="ProvidedBy" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[A pointer to the default provider type for a type.
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.ProvidedBy -->
<!-- start interface com.google.inject.Provider -->
<interface name="Provider" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="get" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Provides an instance of {@code T}. Must never return {@code null}.]]>
</doc>
</method>
<doc>
<![CDATA[Simply, any object capable of providing instances of type {@code T}.
Providers are used in numerous ways by the Guice framework:
<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} 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>}
instance injected, rather than having a {@code T} 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} object from within a {@code @SessionScoped} object),
or instances you don't want to initialize until they are absolutely needed.
<li>A custom {@link Scope} is implemented as a decorator of
{@code Provider<T>}, which decides when to delegate to the backing provider
and when to provide the instance some other way.
<li>The {@link Injector} offers access to the {@code Provider<T>} it uses
to fulfill requests for a given key, via the {@link Injector#getProvider}
methods.
</ul>
@param <T> the type of object this provider provides
@author [email protected] (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Provider -->
<!-- start interface com.google.inject.Scope -->
<interface name="Scope" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="scope" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<param name="unscoped" type="com.google.inject.Provider<T>"/>
<doc>
<![CDATA[Scopes a provider. The returned locator returns objects from this scope. If
an object does not exist in this scope, the provider can use the given
unscoped provider to retrieve one.
<p>Scope implementations are strongly encouraged to override
{@link Object#toString} in the returned provider and include the backing
provider's {@code toString()} output.
@param key binding key
@param unscoped locates an instance when one doesn't already exist in this
scope.
@return a new provider which only delegates to the given unscoped provider
when an instance of the requested object doesn't already exist in this
scope]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A short but useful description of this scope. For comparison, the standard
scopes that ship with guice use the descriptions
{@code "Scopes.SINGLETON"}, {@code "ServletScopes.SESSION"} and
{@code "ServletScopes.REQUEST"}.]]>
</doc>
</method>
<doc>
<![CDATA[A scope is a level of visibility that instances provided by Guice may have.
By default, an instance created by the {@link Injector} has <i>no
scope</i>, meaning it has no state from the framework's perspective -- the
{@code Injector} creates it, injects it once into the class that required it,
and then immediately forgets it. Associating a scope with a particular binding
allows the created instance to be "remembered" and possibly used again for
other injections.
@see Scopes#SINGLETON
@author [email protected] (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Scope -->
<!-- start class com.google.inject.ScopeAnnotation -->
<class name="ScopeAnnotation" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates annotations which are used for scoping. Only one such annotation
may apply to a single implementation class. You must also annotate scope
annotations with {@code @Retention(RUNTIME)}. For example:
<pre>
{@code @}Retention(RUNTIME)
{@code @}Target(TYPE)
{@code @}ScopeAnnotation
public {@code @}interface SessionScoped {}
</pre>
@author [email protected] (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.ScopeAnnotation -->
<!-- start class com.google.inject.Scopes -->
<class name="Scopes" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<field name="SINGLETON" type="com.google.inject.Scope"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[One instance per {@link Injector}. Also see {@code @}{@link Singleton}.]]>
</doc>
</field>
<doc>
<![CDATA[Built in scope implementations.
@author [email protected] (Bob Lee)]]>
</doc>
</class>