1*f585d8a3SJacky Wang /* 2*f585d8a3SJacky Wang * Copyright (C) 2019 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 18*f585d8a3SJacky Wang package dagger.hilt; 19*f585d8a3SJacky Wang 20*f585d8a3SJacky Wang import static java.lang.annotation.RetentionPolicy.CLASS; 21*f585d8a3SJacky Wang 22*f585d8a3SJacky Wang import java.lang.annotation.ElementType; 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 * An annotation that declares which component(s) the annotated class should be included in when 28*f585d8a3SJacky Wang * Hilt generates the components. This may only be used with classes annotated with 29*f585d8a3SJacky Wang * {@literal @}{@link dagger.Module} or {@literal @}{@link dagger.hilt.EntryPoint}. 30*f585d8a3SJacky Wang * 31*f585d8a3SJacky Wang * <p>Example usage for installing a module in the generated {@code ApplicationComponent}: 32*f585d8a3SJacky Wang * 33*f585d8a3SJacky Wang * <pre><code> 34*f585d8a3SJacky Wang * {@literal @}Module 35*f585d8a3SJacky Wang * {@literal @}InstallIn(SingletonComponent.class) 36*f585d8a3SJacky Wang * public final class FooModule { 37*f585d8a3SJacky Wang * {@literal @}Provides 38*f585d8a3SJacky Wang * static Foo provideFoo() { 39*f585d8a3SJacky Wang * return new Foo(); 40*f585d8a3SJacky Wang * } 41*f585d8a3SJacky Wang * } 42*f585d8a3SJacky Wang * </code></pre> 43*f585d8a3SJacky Wang * 44*f585d8a3SJacky Wang * @see <a href="https://dagger.dev/hilt/modules">Hilt Modules</a> 45*f585d8a3SJacky Wang */ 46*f585d8a3SJacky Wang @Retention(CLASS) 47*f585d8a3SJacky Wang @Target({ElementType.TYPE}) 48*f585d8a3SJacky Wang @GeneratesRootInput 49*f585d8a3SJacky Wang public @interface InstallIn { value()50*f585d8a3SJacky Wang Class<?>[] value(); 51*f585d8a3SJacky Wang } 52