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 29 * dagger.multibindings.ElementsIntoSet} for the given type. Example usage: 30 * 31 * <pre><code> 32 * public class FooTest{ 33 * ... 34 * {@literal @}BindElementsIntoSet Set<String> bindedSet = ImmutableSet.of("bar", "baz"); 35 * ... 36 * } 37 * </code></pre> 38 * 39 * Here, bindedSet will be accessible to the entire application for your test. This is functionally 40 * equivalent to installing the following module in your test: 41 * 42 * <pre><code> 43 * {@literal @}Module 44 * {@literal @}InstallIn 45 * interface MyModule { 46 * {@literal @}Provides 47 * {@literal @}ElementsIntoSet 48 * Set<String> bindSet() { 49 * return ImmutableSet.of("bar", "baz"); 50 * } 51 * } 52 * </code></pre> 53 * 54 * Also see {@link BindValueIntoSet}, where you can gather individual elements into one set and bind 55 * it to the application. 56 */ 57 @Retention(CLASS) 58 @Target({ElementType.FIELD}) 59 @GeneratesRootInput 60 public @interface BindElementsIntoSet {} 61