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