1*f585d8a3SJacky Wang /* 2*f585d8a3SJacky Wang * Copyright (C) 2019 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; 18*f585d8a3SJacky Wang 19*f585d8a3SJacky Wang import static java.lang.annotation.ElementType.TYPE; 20*f585d8a3SJacky Wang import static java.lang.annotation.RetentionPolicy.CLASS; 21*f585d8a3SJacky Wang 22*f585d8a3SJacky Wang import dagger.hilt.internal.definecomponent.DefineComponentNoParent; 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 * Defines a Hilt component. 28*f585d8a3SJacky Wang * 29*f585d8a3SJacky Wang * <p>Example defining a root component, {@code ParentComponent}: 30*f585d8a3SJacky Wang * 31*f585d8a3SJacky Wang * <pre><code> 32*f585d8a3SJacky Wang * {@literal @}ParentScoped 33*f585d8a3SJacky Wang * {@literal @}DefineComponent 34*f585d8a3SJacky Wang * interface ParentComponent {} 35*f585d8a3SJacky Wang * </code></pre> 36*f585d8a3SJacky Wang * 37*f585d8a3SJacky Wang * <p>Example defining a child component, {@code ChildComponent}: 38*f585d8a3SJacky Wang * 39*f585d8a3SJacky Wang * <pre><code> 40*f585d8a3SJacky Wang * {@literal @}ChildScoped 41*f585d8a3SJacky Wang * {@literal @}DefineComponent(parent = ParentComponent.class) 42*f585d8a3SJacky Wang * interface ChildComponent {} 43*f585d8a3SJacky Wang * </code></pre> 44*f585d8a3SJacky Wang */ 45*f585d8a3SJacky Wang @Retention(CLASS) 46*f585d8a3SJacky Wang @Target(TYPE) 47*f585d8a3SJacky Wang @GeneratesRootInput 48*f585d8a3SJacky Wang public @interface DefineComponent { 49*f585d8a3SJacky Wang /** Returns the parent of this component, if it exists. */ parent()50*f585d8a3SJacky Wang Class<?> parent() default DefineComponentNoParent.class; 51*f585d8a3SJacky Wang 52*f585d8a3SJacky Wang /** 53*f585d8a3SJacky Wang * Defines a builder for a Hilt component. 54*f585d8a3SJacky Wang * 55*f585d8a3SJacky Wang * <pre><code> 56*f585d8a3SJacky Wang * {@literal @}DefineComponent.Builder 57*f585d8a3SJacky Wang * interface ParentComponentBuilder { 58*f585d8a3SJacky Wang * ParentComponentBuilder seedData(SeedData seed); 59*f585d8a3SJacky Wang * ParentComponent build(); 60*f585d8a3SJacky Wang * } 61*f585d8a3SJacky Wang * </code></pre> 62*f585d8a3SJacky Wang */ 63*f585d8a3SJacky Wang // TODO(bcorso): Consider making this a top-level class to hint that it doesn't need to be nested. 64*f585d8a3SJacky Wang @Retention(CLASS) 65*f585d8a3SJacky Wang @Target(TYPE) 66*f585d8a3SJacky Wang @GeneratesRootInput 67*f585d8a3SJacky Wang public @interface Builder {} 68*f585d8a3SJacky Wang } 69