• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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}. Example usage:
29  *
30  * <pre><code>
31  * public class FooTest{
32  *   ...
33  *   {@literal @}BindValue Bar boundBar = new Bar();
34  *   ...
35  * }
36  * </code></pre>
37  *
38  * Here {@code boundBar} will be accessible to the entire application for your test.
39  */
40 @Retention(CLASS)
41 @Target({ElementType.FIELD})
42 @GeneratesRootInput
43 public @interface BindValue {}
44