1*f585d8a3SJacky Wang /* 2*f585d8a3SJacky Wang * Copyright (C) 2021 The Dagger Authors. 3*f585d8a3SJacky Wang * 4*f585d8a3SJacky Wang * Licensed under the Apache License, Version 2.0 (the "License"); 5*f585d8a3SJacky Wang * you may not use this file except in compliance with the License. 6*f585d8a3SJacky Wang * You may obtain a copy of the License at 7*f585d8a3SJacky Wang * 8*f585d8a3SJacky Wang * http://www.apache.org/licenses/LICENSE-2.0 9*f585d8a3SJacky Wang * 10*f585d8a3SJacky Wang * Unless required by applicable law or agreed to in writing, software 11*f585d8a3SJacky Wang * distributed under the License is distributed on an "AS IS" BASIS, 12*f585d8a3SJacky Wang * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13*f585d8a3SJacky Wang * See the License for the specific language governing permissions and 14*f585d8a3SJacky Wang * limitations under the License. 15*f585d8a3SJacky Wang */ 16*f585d8a3SJacky Wang 17*f585d8a3SJacky Wang package dagger.hilt.android; 18*f585d8a3SJacky Wang 19*f585d8a3SJacky Wang import static java.lang.annotation.RetentionPolicy.RUNTIME; 20*f585d8a3SJacky Wang 21*f585d8a3SJacky Wang import dagger.internal.Beta; 22*f585d8a3SJacky Wang import java.lang.annotation.ElementType; 23*f585d8a3SJacky Wang import java.lang.annotation.Retention; 24*f585d8a3SJacky Wang import java.lang.annotation.Target; 25*f585d8a3SJacky Wang 26*f585d8a3SJacky Wang /** 27*f585d8a3SJacky Wang * An escape hatch for when a Hilt entry point usage needs to be called before the singleton 28*f585d8a3SJacky Wang * component is available in a Hilt test. 29*f585d8a3SJacky Wang * 30*f585d8a3SJacky Wang * <p>Warning: Please see documentation for more details: 31*f585d8a3SJacky Wang * https://dagger.dev/hilt/early-entry-point 32*f585d8a3SJacky Wang * 33*f585d8a3SJacky Wang * <p>Usage: 34*f585d8a3SJacky Wang * 35*f585d8a3SJacky Wang * <p>To enable an existing entry point to be called early in a Hilt test, replace its 36*f585d8a3SJacky Wang * {@link dagger.hilt.EntryPoint} annotation with {@link EarlyEntryPoint}. (Note that, 37*f585d8a3SJacky Wang * {@link EarlyEntryPoint} is only allowed on entry points installed in the 38*f585d8a3SJacky Wang * {@link dagger.hilt.components.SingletonComponent}). 39*f585d8a3SJacky Wang * 40*f585d8a3SJacky Wang * <pre><code> 41*f585d8a3SJacky Wang * @EarlyEntryPoint // <- This replaces @EntryPoint 42*f585d8a3SJacky Wang * @InstallIn(SingletonComponent.class) 43*f585d8a3SJacky Wang * interface FooEntryPoint { 44*f585d8a3SJacky Wang * Foo getFoo(); 45*f585d8a3SJacky Wang * } 46*f585d8a3SJacky Wang * </code></pre> 47*f585d8a3SJacky Wang * 48*f585d8a3SJacky Wang * <p>Then, replace any of the corresponding usages of {@link dagger.hilt.EntryPoints} with 49*f585d8a3SJacky Wang * {@link EarlyEntryPoints}, as shown below: 50*f585d8a3SJacky Wang * 51*f585d8a3SJacky Wang * <pre><code> 52*f585d8a3SJacky Wang * // EarlyEntryPoints.get() must be used with entry points annotated with @EarlyEntryPoint 53*f585d8a3SJacky Wang * // This entry point can now be called at any point during a test, e.g. in Application.onCreate(). 54*f585d8a3SJacky Wang * Foo foo = EarlyEntryPoints.get(appContext, FooEntryPoint.class).getFoo(); 55*f585d8a3SJacky Wang * </code></pre> 56*f585d8a3SJacky Wang */ 57*f585d8a3SJacky Wang @Beta 58*f585d8a3SJacky Wang @Retention(RUNTIME) // Needs to be runtime for checks in EntryPoints and EarlyEntryPoints. 59*f585d8a3SJacky Wang @Target(ElementType.TYPE) 60*f585d8a3SJacky Wang public @interface EarlyEntryPoint {} 61