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