xref: /aosp_15_r20/external/dagger2/java/dagger/producers/ProducerModule.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
1*f585d8a3SJacky Wang /*
2*f585d8a3SJacky Wang  * Copyright (C) 2014 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.producers;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang import static java.lang.annotation.ElementType.TYPE;
20*f585d8a3SJacky Wang import static java.lang.annotation.RetentionPolicy.RUNTIME;
21*f585d8a3SJacky Wang 
22*f585d8a3SJacky Wang import dagger.Module;
23*f585d8a3SJacky Wang import dagger.internal.Beta;
24*f585d8a3SJacky Wang import java.lang.annotation.Documented;
25*f585d8a3SJacky Wang import java.lang.annotation.Retention;
26*f585d8a3SJacky Wang import java.lang.annotation.Target;
27*f585d8a3SJacky Wang 
28*f585d8a3SJacky Wang /**
29*f585d8a3SJacky Wang  * Annotates a class that contributes {@link Produces} bindings to the production component.
30*f585d8a3SJacky Wang  *
31*f585d8a3SJacky Wang  * @since 2.0
32*f585d8a3SJacky Wang  */
33*f585d8a3SJacky Wang @Documented
34*f585d8a3SJacky Wang @Target(TYPE)
35*f585d8a3SJacky Wang @Retention(RUNTIME)
36*f585d8a3SJacky Wang @Beta
37*f585d8a3SJacky Wang public @interface ProducerModule {
38*f585d8a3SJacky Wang   /**
39*f585d8a3SJacky Wang    * Additional {@code @ProducerModule}- or {@link Module}-annotated classes from which this module
40*f585d8a3SJacky Wang    * is composed. The de-duplicated contributions of the modules in {@code includes}, and of their
41*f585d8a3SJacky Wang    * inclusions recursively, are all contributed to the object graph.
42*f585d8a3SJacky Wang    */
includes()43*f585d8a3SJacky Wang   Class<?>[] includes() default {};
44*f585d8a3SJacky Wang 
45*f585d8a3SJacky Wang   /**
46*f585d8a3SJacky Wang    * Any {@link dagger.Subcomponent}- or {@link ProductionSubcomponent}-annotated classes which
47*f585d8a3SJacky Wang    * should be children of the component in which this module is installed. A subcomponent may be
48*f585d8a3SJacky Wang    * listed in more than one module in a component.
49*f585d8a3SJacky Wang    *
50*f585d8a3SJacky Wang    * @since 2.7
51*f585d8a3SJacky Wang    */
subcomponents()52*f585d8a3SJacky Wang   Class<?>[] subcomponents() default {};
53*f585d8a3SJacky Wang }
54