xref: /aosp_15_r20/external/dagger2/java/dagger/model/RequestKind.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
1*f585d8a3SJacky Wang /*
2*f585d8a3SJacky Wang  * Copyright (C) 2017 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.model;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang import static com.google.common.base.CaseFormat.UPPER_CAMEL;
20*f585d8a3SJacky Wang import static com.google.common.base.CaseFormat.UPPER_UNDERSCORE;
21*f585d8a3SJacky Wang 
22*f585d8a3SJacky Wang /**
23*f585d8a3SJacky Wang  * Represents the different kinds of {@link javax.lang.model.type.TypeMirror types} that may be
24*f585d8a3SJacky Wang  * requested as dependencies for the same key. For example, {@code String}, {@code
25*f585d8a3SJacky Wang  * Provider<String>}, and {@code Lazy<String>} can all be requested if a key exists for {@code
26*f585d8a3SJacky Wang  * String}; they have the {@link #INSTANCE}, {@link #PROVIDER}, and {@link #LAZY} request kinds,
27*f585d8a3SJacky Wang  * respectively.
28*f585d8a3SJacky Wang  */
29*f585d8a3SJacky Wang public enum RequestKind {
30*f585d8a3SJacky Wang   /** A default request for an instance. E.g.: {@code FooType} */
31*f585d8a3SJacky Wang   INSTANCE,
32*f585d8a3SJacky Wang 
33*f585d8a3SJacky Wang   /** A request for a {@code Provider}. E.g.: {@code Provider<FooType>} */
34*f585d8a3SJacky Wang   PROVIDER,
35*f585d8a3SJacky Wang 
36*f585d8a3SJacky Wang   /** A request for a {@code Lazy}. E.g.: {@code Lazy<FooType>} */
37*f585d8a3SJacky Wang   LAZY,
38*f585d8a3SJacky Wang 
39*f585d8a3SJacky Wang   /** A request for a {@code Provider} of a {@code Lazy}. E.g.: {@code Provider<Lazy<FooType>>} */
40*f585d8a3SJacky Wang   PROVIDER_OF_LAZY,
41*f585d8a3SJacky Wang 
42*f585d8a3SJacky Wang   /**
43*f585d8a3SJacky Wang    * A request for a members injection. E.g. {@code void injectMembers(FooType);}. Can only be
44*f585d8a3SJacky Wang    * requested by component interfaces.
45*f585d8a3SJacky Wang    */
46*f585d8a3SJacky Wang   MEMBERS_INJECTION,
47*f585d8a3SJacky Wang 
48*f585d8a3SJacky Wang   /** A request for a {@code Producer}. E.g.: {@code Producer<FooType>} */
49*f585d8a3SJacky Wang   PRODUCER,
50*f585d8a3SJacky Wang 
51*f585d8a3SJacky Wang   /** A request for a {@code Produced}. E.g.: {@code Produced<FooType>} */
52*f585d8a3SJacky Wang   PRODUCED,
53*f585d8a3SJacky Wang 
54*f585d8a3SJacky Wang   /**
55*f585d8a3SJacky Wang    * A request for a {@code ListenableFuture}. E.g.: {@code ListenableFuture<FooType>}. These can
56*f585d8a3SJacky Wang    * only be requested by component interfaces.
57*f585d8a3SJacky Wang    */
58*f585d8a3SJacky Wang   FUTURE,
59*f585d8a3SJacky Wang   ;
60*f585d8a3SJacky Wang 
61*f585d8a3SJacky Wang   /** Returns a string that represents requests of this kind for a key. */
format(Key key)62*f585d8a3SJacky Wang   public String format(Key key) {
63*f585d8a3SJacky Wang     switch (this) {
64*f585d8a3SJacky Wang       case INSTANCE:
65*f585d8a3SJacky Wang         return key.toString();
66*f585d8a3SJacky Wang 
67*f585d8a3SJacky Wang       case PROVIDER_OF_LAZY:
68*f585d8a3SJacky Wang         return String.format("Provider<Lazy<%s>>", key);
69*f585d8a3SJacky Wang 
70*f585d8a3SJacky Wang       case MEMBERS_INJECTION:
71*f585d8a3SJacky Wang         return String.format("injectMembers(%s)", key);
72*f585d8a3SJacky Wang 
73*f585d8a3SJacky Wang       case FUTURE:
74*f585d8a3SJacky Wang         return String.format("ListenableFuture<%s>", key);
75*f585d8a3SJacky Wang 
76*f585d8a3SJacky Wang       default:
77*f585d8a3SJacky Wang         return String.format("%s<%s>", UPPER_UNDERSCORE.to(UPPER_CAMEL, name()), key);
78*f585d8a3SJacky Wang     }
79*f585d8a3SJacky Wang   }
80*f585d8a3SJacky Wang }
81