• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2016 The Dagger Authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package dagger.internal.codegen.javapoet;
18 
19 import androidx.room.compiler.processing.XType;
20 import com.google.common.collect.ImmutableSet;
21 import com.squareup.javapoet.ClassName;
22 import com.squareup.javapoet.ParameterizedTypeName;
23 import com.squareup.javapoet.TypeName;
24 
25 /** Common names and convenience methods for JavaPoet {@link TypeName} usage. */
26 public final class TypeNames {
27 
28   // Dagger Core classnames
29   public static final ClassName ASSISTED = ClassName.get("dagger.assisted", "Assisted");
30   public static final ClassName ASSISTED_FACTORY =
31       ClassName.get("dagger.assisted", "AssistedFactory");
32   public static final ClassName ASSISTED_INJECT =
33       ClassName.get("dagger.assisted", "AssistedInject");
34   public static final ClassName BINDS = ClassName.get("dagger", "Binds");
35   public static final ClassName BINDS_INSTANCE = ClassName.get("dagger", "BindsInstance");
36   public static final ClassName BINDS_OPTIONAL_OF = ClassName.get("dagger", "BindsOptionalOf");
37   public static final ClassName COMPONENT = ClassName.get("dagger", "Component");
38   public static final ClassName COMPONENT_BUILDER = COMPONENT.nestedClass("Builder");
39   public static final ClassName COMPONENT_FACTORY = COMPONENT.nestedClass("Factory");
40   public static final ClassName DAGGER_PROCESSING_OPTIONS =
41       ClassName.get("dagger", "DaggerProcessingOptions");
42   public static final ClassName ELEMENTS_INTO_SET =
43       ClassName.get("dagger.multibindings", "ElementsIntoSet");
44   public static final ClassName INTO_MAP = ClassName.get("dagger.multibindings", "IntoMap");
45   public static final ClassName INTO_SET = ClassName.get("dagger.multibindings", "IntoSet");
46   public static final ClassName MAP_KEY = ClassName.get("dagger", "MapKey");
47   public static final ClassName MODULE = ClassName.get("dagger", "Module");
48   public static final ClassName MULTIBINDS = ClassName.get("dagger.multibindings", "Multibinds");
49   public static final ClassName PROVIDES = ClassName.get("dagger", "Provides");
50   public static final ClassName REUSABLE = ClassName.get("dagger", "Reusable");
51   public static final ClassName SUBCOMPONENT = ClassName.get("dagger", "Subcomponent");
52   public static final ClassName SUBCOMPONENT_BUILDER = SUBCOMPONENT.nestedClass("Builder");
53   public static final ClassName SUBCOMPONENT_FACTORY = SUBCOMPONENT.nestedClass("Factory");
54 
55   // Dagger Internal classnames
56   public static final ClassName IDENTIFIER_NAME_STRING =
57       ClassName.get("dagger.internal", "IdentifierNameString");
58   public static final ClassName KEEP_FIELD_TYPE = ClassName.get("dagger.internal", "KeepFieldType");
59   public static final ClassName LAZY_CLASS_KEY =
60       ClassName.get("dagger.multibindings", "LazyClassKey");
61   public static final ClassName LAZY_CLASS_KEY_MAP =
62       ClassName.get("dagger.internal", "LazyClassKeyMap");
63   public static final ClassName LAZY_CLASS_KEY_MAP_FACTORY =
64       ClassName.get("dagger.internal", "LazyClassKeyMap", "Factory");
65 
66   public static final ClassName DELEGATE_FACTORY =
67       ClassName.get("dagger.internal", "DelegateFactory");
68   public static final ClassName DOUBLE_CHECK = ClassName.get("dagger.internal", "DoubleCheck");
69 
70   public static final ClassName FACTORY = ClassName.get("dagger.internal", "Factory");
71   public static final ClassName INJECTED_FIELD_SIGNATURE =
72       ClassName.get("dagger.internal", "InjectedFieldSignature");
73   public static final ClassName INSTANCE_FACTORY =
74       ClassName.get("dagger.internal", "InstanceFactory");
75   public static final ClassName MAP_BUILDER = ClassName.get("dagger.internal", "MapBuilder");
76   public static final ClassName MAP_FACTORY = ClassName.get("dagger.internal", "MapFactory");
77   public static final ClassName MAP_PROVIDER_FACTORY =
78       ClassName.get("dagger.internal", "MapProviderFactory");
79   public static final ClassName MEMBERS_INJECTOR = ClassName.get("dagger", "MembersInjector");
80   public static final ClassName MEMBERS_INJECTORS =
81       ClassName.get("dagger.internal", "MembersInjectors");
82   public static final ClassName PROVIDER = ClassName.get("javax.inject", "Provider");
83   public static final ClassName DAGGER_PROVIDER = ClassName.get("dagger.internal", "Provider");
84   public static final ClassName DAGGER_PROVIDERS = ClassName.get("dagger.internal", "Providers");
85   public static final ClassName PROVIDER_OF_LAZY =
86       ClassName.get("dagger.internal", "ProviderOfLazy");
87   public static final ClassName SCOPE_METADATA = ClassName.get("dagger.internal", "ScopeMetadata");
88   public static final ClassName QUALIFIER_METADATA =
89       ClassName.get("dagger.internal", "QualifierMetadata");
90   public static final ClassName SET_FACTORY = ClassName.get("dagger.internal", "SetFactory");
91   public static final ClassName SINGLE_CHECK = ClassName.get("dagger.internal", "SingleCheck");
92   public static final ClassName LAZY = ClassName.get("dagger", "Lazy");
93 
94   // Dagger Producers classnames
95   public static final ClassName ABSTRACT_PRODUCER =
96       ClassName.get("dagger.producers.internal", "AbstractProducer");
97   public static final ClassName ABSTRACT_PRODUCES_METHOD_PRODUCER =
98       ClassName.get("dagger.producers.internal", "AbstractProducesMethodProducer");
99   public static final ClassName CANCELLATION_LISTENER =
100       ClassName.get("dagger.producers.internal", "CancellationListener");
101   public static final ClassName CANCELLATION_POLICY =
102       ClassName.get("dagger.producers", "CancellationPolicy");
103   public static final ClassName DELEGATE_PRODUCER =
104       ClassName.get("dagger.producers.internal", "DelegateProducer");
105   public static final ClassName DEPENDENCY_METHOD_PRODUCER =
106       ClassName.get("dagger.producers.internal", "DependencyMethodProducer");
107   public static final ClassName MAP_OF_PRODUCED_PRODUCER =
108       ClassName.get("dagger.producers.internal", "MapOfProducedProducer");
109   public static final ClassName MAP_OF_PRODUCER_PRODUCER =
110       ClassName.get("dagger.producers.internal", "MapOfProducerProducer");
111   public static final ClassName MAP_PRODUCER =
112       ClassName.get("dagger.producers.internal", "MapProducer");
113   public static final ClassName MONITORS =
114       ClassName.get("dagger.producers.monitoring.internal", "Monitors");
115   public static final ClassName PRODUCED = ClassName.get("dagger.producers", "Produced");
116   public static final ClassName PRODUCER = ClassName.get("dagger.producers", "Producer");
117   public static final ClassName PRODUCERS = ClassName.get("dagger.producers.internal", "Producers");
118   public static final ClassName PRODUCER_MODULE =
119       ClassName.get("dagger.producers", "ProducerModule");
120   public static final ClassName PRODUCES = ClassName.get("dagger.producers", "Produces");
121   public static final ClassName PRODUCTION = ClassName.get("dagger.producers", "Production");
122   public static final ClassName PRODUCTION_COMPONENT =
123       ClassName.get("dagger.producers", "ProductionComponent");
124   public static final ClassName PRODUCTION_COMPONENT_BUILDER =
125       PRODUCTION_COMPONENT.nestedClass("Builder");
126   public static final ClassName PRODUCTION_COMPONENT_FACTORY =
127       PRODUCTION_COMPONENT.nestedClass("Factory");
128   public static final ClassName PRODUCTION_EXECTUTOR_MODULE =
129       ClassName.get("dagger.producers.internal", "ProductionExecutorModule");
130   public static final ClassName PRODUCTION_IMPLEMENTATION =
131       ClassName.get("dagger.producers.internal", "ProductionImplementation");
132   public static final ClassName PRODUCTION_SUBCOMPONENT =
133       ClassName.get("dagger.producers", "ProductionSubcomponent");
134   public static final ClassName PRODUCTION_SUBCOMPONENT_BUILDER =
135       PRODUCTION_SUBCOMPONENT.nestedClass("Builder");
136   public static final ClassName PRODUCTION_SUBCOMPONENT_FACTORY =
137       PRODUCTION_SUBCOMPONENT.nestedClass("Factory");
138   public static final ClassName PRODUCER_TOKEN =
139       ClassName.get("dagger.producers.monitoring", "ProducerToken");
140   public static final ClassName PRODUCTION_COMPONENT_MONITOR =
141       ClassName.get("dagger.producers.monitoring", "ProductionComponentMonitor");
142   public static final ClassName PRODUCTION_COMPONENT_MONITOR_FACTORY =
143       ClassName.get("dagger.producers.monitoring", "ProductionComponentMonitor", "Factory");
144   public static final ClassName SET_OF_PRODUCED_PRODUCER =
145       ClassName.get("dagger.producers.internal", "SetOfProducedProducer");
146   public static final ClassName SET_PRODUCER =
147       ClassName.get("dagger.producers.internal", "SetProducer");
148   public static final ClassName PRODUCTION_SCOPE =
149       ClassName.get("dagger.producers", "ProductionScope");
150 
151   // Other classnames
152   public static final ClassName EXECUTOR = ClassName.get("java.util.concurrent", "Executor");
153   public static final ClassName ERROR = ClassName.get("java.lang", "Error");
154   public static final ClassName EXCEPTION = ClassName.get("java.lang", "Exception");
155   public static final ClassName RUNTIME_EXCEPTION = ClassName.get("java.lang", "RuntimeException");
156   public static final ClassName STRING = ClassName.get("java.lang", "String");
157 
158   public static final ClassName MAP = ClassName.get("java.util", "Map");
159   public static final ClassName KOTLIN_METADATA = ClassName.get("kotlin", "Metadata");
160   public static final ClassName IMMUTABLE_MAP =
161       ClassName.get("com.google.common.collect", "ImmutableMap");
162   public static final ClassName SINGLETON = ClassName.get("jakarta.inject", "Singleton");
163   public static final ClassName SINGLETON_JAVAX = ClassName.get("javax.inject", "Singleton");
164   public static final ClassName SCOPE = ClassName.get("jakarta.inject", "Scope");
165   public static final ClassName SCOPE_JAVAX = ClassName.get("javax.inject", "Scope");
166   public static final ClassName INJECT = ClassName.get("jakarta.inject", "Inject");
167   public static final ClassName INJECT_JAVAX = ClassName.get("javax.inject", "Inject");
168   public static final ClassName QUALIFIER = ClassName.get("jakarta.inject", "Qualifier");
169   public static final ClassName QUALIFIER_JAVAX = ClassName.get("javax.inject", "Qualifier");
170   public static final ClassName COLLECTION = ClassName.get("java.util", "Collection");
171   public static final ClassName LIST = ClassName.get("java.util", "List");
172   public static final ClassName SET = ClassName.get("java.util", "Set");
173   public static final ClassName IMMUTABLE_SET =
174       ClassName.get("com.google.common.collect", "ImmutableSet");
175   public static final ClassName FUTURES =
176       ClassName.get("com.google.common.util.concurrent", "Futures");
177   public static final ClassName LISTENABLE_FUTURE =
178       ClassName.get("com.google.common.util.concurrent", "ListenableFuture");
179   public static final ClassName FLUENT_FUTURE =
180       ClassName.get("com.google.common.util.concurrent", "FluentFuture");
181   public static final ClassName GUAVA_OPTIONAL =
182       ClassName.get("com.google.common.base", "Optional");
183   public static final ClassName JDK_OPTIONAL = ClassName.get("java.util", "Optional");
184   public static final ClassName OVERRIDE = ClassName.get("java.lang", "Override");
185   public static final ClassName JVM_STATIC = ClassName.get("kotlin.jvm", "JvmStatic");
186   public static final ClassName CLASS = ClassName.get("java.lang", "Class");
187   public static final ClassName KCLASS = ClassName.get("kotlin.reflect", "KClass");
188 
189   /**
190    * {@link TypeName#VOID} is lowercase-v {@code void} whereas this represents the class, {@link
191    * Void}.
192    */
193   public static final ClassName VOID_CLASS = ClassName.get(Void.class);
194 
abstractProducerOf(TypeName typeName)195   public static ParameterizedTypeName abstractProducerOf(TypeName typeName) {
196     return ParameterizedTypeName.get(ABSTRACT_PRODUCER, typeName);
197   }
198 
factoryOf(TypeName factoryType)199   public static ParameterizedTypeName factoryOf(TypeName factoryType) {
200     return ParameterizedTypeName.get(FACTORY, factoryType);
201   }
202 
lazyOf(TypeName typeName)203   public static ParameterizedTypeName lazyOf(TypeName typeName) {
204     return ParameterizedTypeName.get(LAZY, typeName);
205   }
206 
listOf(TypeName typeName)207   public static ParameterizedTypeName listOf(TypeName typeName) {
208     return ParameterizedTypeName.get(LIST, typeName);
209   }
210 
listenableFutureOf(TypeName typeName)211   public static ParameterizedTypeName listenableFutureOf(TypeName typeName) {
212     return ParameterizedTypeName.get(LISTENABLE_FUTURE, typeName);
213   }
214 
membersInjectorOf(TypeName membersInjectorType)215   public static ParameterizedTypeName membersInjectorOf(TypeName membersInjectorType) {
216     return ParameterizedTypeName.get(MEMBERS_INJECTOR, membersInjectorType);
217   }
218 
producedOf(TypeName typeName)219   public static ParameterizedTypeName producedOf(TypeName typeName) {
220     return ParameterizedTypeName.get(PRODUCED, typeName);
221   }
222 
producerOf(TypeName typeName)223   public static ParameterizedTypeName producerOf(TypeName typeName) {
224     return ParameterizedTypeName.get(PRODUCER, typeName);
225   }
226 
dependencyMethodProducerOf(TypeName typeName)227   public static ParameterizedTypeName dependencyMethodProducerOf(TypeName typeName) {
228     return ParameterizedTypeName.get(DEPENDENCY_METHOD_PRODUCER, typeName);
229   }
230 
providerOf(TypeName typeName)231   public static ParameterizedTypeName providerOf(TypeName typeName) {
232     return ParameterizedTypeName.get(PROVIDER, typeName);
233   }
234 
daggerProviderOf(TypeName typeName)235   public static ParameterizedTypeName daggerProviderOf(TypeName typeName) {
236     return ParameterizedTypeName.get(DAGGER_PROVIDER, typeName);
237   }
238 
setOf(TypeName elementType)239   public static ParameterizedTypeName setOf(TypeName elementType) {
240     return ParameterizedTypeName.get(SET, elementType);
241   }
242 
243   private static final ImmutableSet<ClassName> FUTURE_TYPES =
244       ImmutableSet.of(LISTENABLE_FUTURE, FLUENT_FUTURE);
245 
isFutureType(XType type)246   public static boolean isFutureType(XType type) {
247     return isFutureType(type.getTypeName());
248   }
249 
isFutureType(TypeName typeName)250   public static boolean isFutureType(TypeName typeName) {
251     return FUTURE_TYPES.contains(rawTypeName(typeName));
252   }
253 
254   /**
255    * Returns the {@link TypeName} for the raw type of the given {@link TypeName}. If the argument
256    * isn't a parameterized type, it returns the argument unchanged.
257    */
rawTypeName(TypeName typeName)258   public static TypeName rawTypeName(TypeName typeName) {
259     return (typeName instanceof ParameterizedTypeName)
260         ? ((ParameterizedTypeName) typeName).rawType
261         : typeName;
262   }
263 
TypeNames()264   private TypeNames() {}
265 }
266