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.android.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 can be used on a test field to contribute the value into the {@link 28 * dagger.hilt.components.SingletonComponent} as an {@link dagger.multibindings.IntoMap} 29 * for the given type. Example usage: 30 * 31 * <pre><code> 32 * public class FooTest{ 33 * ... 34 * {@literal @}BindValueIntoMap 35 * {@literal @}MyMapKey(KEY1) 36 * String boundBar = "bar"; 37 * 38 * {@literal @}BindValueIntoMap 39 * {@literal @}MyMapKey(KEY2) 40 * String boundBaz = "baz"; 41 * ... 42 * } 43 * </code></pre> 44 * 45 * Here the map that contains all the bound elements (in this case "bar" and "baz") will be 46 * accessible to the entire application for your test. 47 */ 48 @Retention(CLASS) 49 @Target({ElementType.FIELD}) 50 @GeneratesRootInput 51 public @interface BindValueIntoMap {} 52