xref: /aosp_15_r20/external/dagger2/java/dagger/spi/model/BindingKind.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27) 
1*f585d8a3SJacky Wang /*
2*f585d8a3SJacky Wang  * Copyright (C) 2021 The Dagger Authors.
3*f585d8a3SJacky Wang  *
4*f585d8a3SJacky Wang  * Licensed under the Apache License, Version 2.0 (the "License");
5*f585d8a3SJacky Wang  * you may not use this file except in compliance with the License.
6*f585d8a3SJacky Wang  * You may obtain a copy of the License at
7*f585d8a3SJacky Wang  *
8*f585d8a3SJacky Wang  * http://www.apache.org/licenses/LICENSE-2.0
9*f585d8a3SJacky Wang  *
10*f585d8a3SJacky Wang  * Unless required by applicable law or agreed to in writing, software
11*f585d8a3SJacky Wang  * distributed under the License is distributed on an "AS IS" BASIS,
12*f585d8a3SJacky Wang  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*f585d8a3SJacky Wang  * See the License for the specific language governing permissions and
14*f585d8a3SJacky Wang  * limitations under the License.
15*f585d8a3SJacky Wang  */
16*f585d8a3SJacky Wang 
17*f585d8a3SJacky Wang package dagger.spi.model;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang /** Represents the different kinds of {@link Binding}s that can exist in a binding graph. */
20*f585d8a3SJacky Wang public enum BindingKind {
21*f585d8a3SJacky Wang   /** A binding for an {@link javax.inject.Inject}-annotated constructor. */
22*f585d8a3SJacky Wang   INJECTION,
23*f585d8a3SJacky Wang 
24*f585d8a3SJacky Wang   /** A binding for a {@link dagger.Provides}-annotated method. */
25*f585d8a3SJacky Wang   PROVISION,
26*f585d8a3SJacky Wang 
27*f585d8a3SJacky Wang   /**
28*f585d8a3SJacky Wang    * A binding for an {@link javax.inject.Inject}-annotated constructor that contains at least one
29*f585d8a3SJacky Wang    * {@link dagger.assisted.Assisted}-annotated parameter.
30*f585d8a3SJacky Wang    */
31*f585d8a3SJacky Wang   ASSISTED_INJECTION,
32*f585d8a3SJacky Wang 
33*f585d8a3SJacky Wang   /** A binding for an {@link dagger.assisted.AssistedFactory}-annotated type. */
34*f585d8a3SJacky Wang   ASSISTED_FACTORY,
35*f585d8a3SJacky Wang 
36*f585d8a3SJacky Wang   /**
37*f585d8a3SJacky Wang    * An implicit binding for a {@link dagger.Component}- or {@code ProductionComponent}-annotated
38*f585d8a3SJacky Wang    * type.
39*f585d8a3SJacky Wang    */
40*f585d8a3SJacky Wang   COMPONENT,
41*f585d8a3SJacky Wang 
42*f585d8a3SJacky Wang   /**
43*f585d8a3SJacky Wang    * A binding for a provision method on a component's {@linkplain dagger.Component#dependencies()
44*f585d8a3SJacky Wang    * dependency}.
45*f585d8a3SJacky Wang    */
46*f585d8a3SJacky Wang   COMPONENT_PROVISION,
47*f585d8a3SJacky Wang 
48*f585d8a3SJacky Wang   /**
49*f585d8a3SJacky Wang    * A binding for an instance of a component's {@linkplain dagger.Component#dependencies()
50*f585d8a3SJacky Wang    * dependency}.
51*f585d8a3SJacky Wang    */
52*f585d8a3SJacky Wang   COMPONENT_DEPENDENCY,
53*f585d8a3SJacky Wang 
54*f585d8a3SJacky Wang   /** A binding for a {@link dagger.MembersInjector} of a type. */
55*f585d8a3SJacky Wang   MEMBERS_INJECTOR,
56*f585d8a3SJacky Wang 
57*f585d8a3SJacky Wang   /**
58*f585d8a3SJacky Wang    * A binding for a subcomponent creator (a {@linkplain dagger.Subcomponent.Builder builder} or
59*f585d8a3SJacky Wang    * {@linkplain dagger.Subcomponent.Factory factory}).
60*f585d8a3SJacky Wang    *
61*f585d8a3SJacky Wang    * @since 2.22 (previously named {@code SUBCOMPONENT_BUILDER})
62*f585d8a3SJacky Wang    */
63*f585d8a3SJacky Wang   SUBCOMPONENT_CREATOR,
64*f585d8a3SJacky Wang 
65*f585d8a3SJacky Wang   /** A binding for a {@link dagger.BindsInstance}-annotated builder method. */
66*f585d8a3SJacky Wang   BOUND_INSTANCE,
67*f585d8a3SJacky Wang 
68*f585d8a3SJacky Wang   /** A binding for a {@code Produces}-annotated method. */
69*f585d8a3SJacky Wang   PRODUCTION,
70*f585d8a3SJacky Wang 
71*f585d8a3SJacky Wang   /**
72*f585d8a3SJacky Wang    * A binding for a production method on a production component's
73*f585d8a3SJacky Wang    * {@code ProductionComponent#dependencies()} that returns a {@code ListenableFuture} or
74*f585d8a3SJacky Wang    * {@code FluentFuture}. Methods on production component dependencies
75*f585d8a3SJacky Wang    * that don't return a future are considered component provision bindings.
76*f585d8a3SJacky Wang    */
77*f585d8a3SJacky Wang   COMPONENT_PRODUCTION,
78*f585d8a3SJacky Wang 
79*f585d8a3SJacky Wang   /**
80*f585d8a3SJacky Wang    * A synthetic binding for a multibound set that depends on individual multibinding {@link
81*f585d8a3SJacky Wang    * #PROVISION} or {@link #PRODUCTION} contributions.
82*f585d8a3SJacky Wang    */
83*f585d8a3SJacky Wang   MULTIBOUND_SET,
84*f585d8a3SJacky Wang 
85*f585d8a3SJacky Wang   /**
86*f585d8a3SJacky Wang    * A synthetic binding for a multibound map that depends on the individual multibinding {@link
87*f585d8a3SJacky Wang    * #PROVISION} or {@link #PRODUCTION} contributions.
88*f585d8a3SJacky Wang    */
89*f585d8a3SJacky Wang   MULTIBOUND_MAP,
90*f585d8a3SJacky Wang 
91*f585d8a3SJacky Wang   /**
92*f585d8a3SJacky Wang    * A synthetic binding for {@code Optional} of a type or a {@link javax.inject.Provider}, {@link
93*f585d8a3SJacky Wang    * dagger.Lazy}, or {@code Provider} of {@code Lazy} of a type. Generated by a {@link
94*f585d8a3SJacky Wang    * dagger.BindsOptionalOf} declaration.
95*f585d8a3SJacky Wang    */
96*f585d8a3SJacky Wang   OPTIONAL,
97*f585d8a3SJacky Wang 
98*f585d8a3SJacky Wang   /**
99*f585d8a3SJacky Wang    * A binding for {@link dagger.Binds}-annotated method that that delegates from requests for one
100*f585d8a3SJacky Wang    * key to another.
101*f585d8a3SJacky Wang    */
102*f585d8a3SJacky Wang   // TODO(dpb,ronshapiro): This name is confusing and could use work. Not all usages of @Binds
103*f585d8a3SJacky Wang   // bindings are simple delegations and we should have a name that better reflects that
104*f585d8a3SJacky Wang   DELEGATE,
105*f585d8a3SJacky Wang 
106*f585d8a3SJacky Wang   /** A binding for a members injection method on a component. */
107*f585d8a3SJacky Wang   MEMBERS_INJECTION,
108*f585d8a3SJacky Wang   ;
109*f585d8a3SJacky Wang 
110*f585d8a3SJacky Wang   /**
111*f585d8a3SJacky Wang    * Returns {@code true} if this is a kind of multibinding (not a contribution to a multibinding,
112*f585d8a3SJacky Wang    * but the multibinding itself).
113*f585d8a3SJacky Wang    */
isMultibinding()114*f585d8a3SJacky Wang   public boolean isMultibinding() {
115*f585d8a3SJacky Wang     switch (this) {
116*f585d8a3SJacky Wang       case MULTIBOUND_MAP:
117*f585d8a3SJacky Wang       case MULTIBOUND_SET:
118*f585d8a3SJacky Wang         return true;
119*f585d8a3SJacky Wang 
120*f585d8a3SJacky Wang       default:
121*f585d8a3SJacky Wang         return false;
122*f585d8a3SJacky Wang     }
123*f585d8a3SJacky Wang   }
124*f585d8a3SJacky Wang }
125