1*f585d8a3SJacky Wang /* 2*f585d8a3SJacky Wang * Copyright (C) 2020 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.migration; 18*f585d8a3SJacky Wang 19*f585d8a3SJacky Wang import dagger.hilt.GeneratesRootInput; 20*f585d8a3SJacky Wang import java.lang.annotation.Annotation; 21*f585d8a3SJacky Wang import java.lang.annotation.ElementType; 22*f585d8a3SJacky Wang import java.lang.annotation.Retention; 23*f585d8a3SJacky Wang import java.lang.annotation.RetentionPolicy; 24*f585d8a3SJacky Wang import java.lang.annotation.Target; 25*f585d8a3SJacky Wang 26*f585d8a3SJacky Wang /** 27*f585d8a3SJacky Wang * Defines an alias between an existing Hilt scope and the annotated scope. For example, the 28*f585d8a3SJacky Wang * following code makes {@literal @}MyScope a functional replacement for {@literal @}ActivityScope. 29*f585d8a3SJacky Wang * 30*f585d8a3SJacky Wang * <p> 31*f585d8a3SJacky Wang * 32*f585d8a3SJacky Wang * <pre> 33*f585d8a3SJacky Wang * {@literal @}Scope 34*f585d8a3SJacky Wang * {@literal @}AliasOf(ActivityScope.class) 35*f585d8a3SJacky Wang * public {@literal @}interface MyScope{} 36*f585d8a3SJacky Wang * </pre> 37*f585d8a3SJacky Wang * 38*f585d8a3SJacky Wang * <p> 39*f585d8a3SJacky Wang */ 40*f585d8a3SJacky Wang @Target(ElementType.ANNOTATION_TYPE) 41*f585d8a3SJacky Wang @Retention(RetentionPolicy.CLASS) 42*f585d8a3SJacky Wang @GeneratesRootInput 43*f585d8a3SJacky Wang public @interface AliasOf { 44*f585d8a3SJacky Wang /** Returns the existing Hilt scope(s) that the annotated scope is aliasing. */ value()45*f585d8a3SJacky Wang Class<? extends Annotation>[] value(); 46*f585d8a3SJacky Wang } 47