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