1 /* 2 * Copyright (C) 2020 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.hilt.testing; 18 19 import static java.lang.annotation.RetentionPolicy.CLASS; 20 21 import dagger.hilt.GeneratesRootInput; 22 import java.lang.annotation.ElementType; 23 import java.lang.annotation.Retention; 24 import java.lang.annotation.Target; 25 26 /** 27 * An annotation that replaces one or more {@link dagger.hilt.InstallIn} modules with the annotated 28 * module in tests. 29 * 30 * <p>The annotated class must also be annotated with {@link dagger.Module}. 31 * 32 * <p>Example: 33 * 34 * <pre><code> 35 * // Replaces FooModule with FakeFooModule, and installs it into the same component as FooModule. 36 * {@literal @}Module 37 * {@literal @}TestInstallIn(components = SingletonComponent.class, replaces = FooModule.class) 38 * public final class FakeFooModule { 39 * {@literal @}Provides 40 * static Foo provideFoo() { 41 * return new FakeFoo(); 42 * } 43 * } 44 * </code></pre> 45 * 46 * @see <a href="https://dagger.dev/hilt/modules">Hilt Modules</a> 47 */ 48 @Retention(CLASS) 49 @Target({ElementType.TYPE}) 50 @GeneratesRootInput 51 public @interface TestInstallIn { 52 /** Returns the component(s) into which the annotated module will be installed. */ components()53 Class<?>[] components(); 54 55 /** Returns the {@link InstallIn} module(s) that the annotated class will replace in tests. */ replaces()56 Class<?>[] replaces(); 57 } 58