summaryrefslogtreecommitdiff
path: root/java/com/android/dialer/rootcomponentgenerator/annotation/DialerComponent.java
blob: 573abae7f9d5de0bfe22ee08df787d2d6bd8ede2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License
 */

package com.android.dialer.rootcomponentgenerator.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

/**
 * Annotates a type equivalent to {@link dagger.Subcomponent}.
 *
 * <p>The annotation processor will generate a new type file with some prefix, which contains public
 * static XXX get(Context context) method and HasComponent interface like:
 *
 * <p>
 *
 * <pre>
 * <code>
 *  public static SimulatorComponent get(Context context) {
 *      HasRootComponent hasRootComponent = (HasRootComponent) context.getApplicationContext();
 *      return ((HasComponent)(hasRootComponent.component()).simulatorComponent();
 *  }
 *  public interface HasComponent {
 *      SimulatorComponent simulatorComponent();
 *  }
 * </code>
 * </pre>
 */
@Target(ElementType.TYPE)
public @interface DialerComponent {
  Class<?>[] modules() default {};
}