xref: /aosp_15_r20/external/dagger2/java/dagger/android/ContributesAndroidInjector.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.android;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang import static java.lang.annotation.ElementType.METHOD;
20*f585d8a3SJacky Wang import static java.lang.annotation.RetentionPolicy.RUNTIME;
21*f585d8a3SJacky Wang 
22*f585d8a3SJacky Wang import java.lang.annotation.Documented;
23*f585d8a3SJacky Wang import java.lang.annotation.Retention;
24*f585d8a3SJacky Wang import java.lang.annotation.Target;
25*f585d8a3SJacky Wang 
26*f585d8a3SJacky Wang /**
27*f585d8a3SJacky Wang  * Generates an {@link AndroidInjector} for the return type of this method. The injector is
28*f585d8a3SJacky Wang  * implemented with a {@link dagger.Subcomponent} and will be a child of the {@link dagger.Module}'s
29*f585d8a3SJacky Wang  * component.
30*f585d8a3SJacky Wang  *
31*f585d8a3SJacky Wang  * <p>This annotation must be applied to an abstract method in a {@link dagger.Module} that returns
32*f585d8a3SJacky Wang  * a concrete Android framework type (e.g. {@code FooActivity}, {@code BarFragment}, {@code
33*f585d8a3SJacky Wang  * MyService}, etc). The method should have no parameters.
34*f585d8a3SJacky Wang  *
35*f585d8a3SJacky Wang  * <p>For more information, see <a href="https://dagger.dev/android">the docs</a>
36*f585d8a3SJacky Wang  */
37*f585d8a3SJacky Wang @Documented
38*f585d8a3SJacky Wang @Retention(RUNTIME)
39*f585d8a3SJacky Wang @Target(METHOD)
40*f585d8a3SJacky Wang public @interface ContributesAndroidInjector {
41*f585d8a3SJacky Wang   /** Modules to be installed in the generated {@link dagger.Subcomponent}. */
modules()42*f585d8a3SJacky Wang   Class<?>[] modules() default {};
43*f585d8a3SJacky Wang }
44