src/keepanno/java/com/android/tools/r8/keepanno/annotations/AnnotationPattern.java

// Copyright (c) 2024, the R8 project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// ***********************************************************************************
// GENERATED FILE. DO NOT EDIT! See KeepItemAnnotationGenerator.java.
// ***********************************************************************************

package com.android.tools.r8.keepanno.annotations;

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

/**
 * A pattern structure for matching annotations.
 *
 * <p>If no properties are set, the default pattern matches any annotation with a runtime retention
 * policy.
 */
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface AnnotationPattern {

  /**
   * Define the annotation-name pattern by fully qualified class name.
   *
   * <p>Mutually exclusive with the following other properties defining annotation-name:
   *
   * <ul>
   *   <li>constant
   *   <li>namePattern
   * </ul>
   *
   * <p>If none are specified the default is to match any annotation name.
   *
   * @return The qualified class name that defines the annotation.
   */
  String name() default "";

  /**
   * Define the annotation-name pattern by reference to a {@code Class} constant.
   *
   * <p>Mutually exclusive with the following other properties defining annotation-name:
   *
   * <ul>
   *   <li>name
   *   <li>namePattern
   * </ul>
   *
   * <p>If none are specified the default is to match any annotation name.
   *
   * @return The Class constant that defines the annotation.
   */
  Class<?> constant() default Object.class;

  /**
   * Define the annotation-name pattern by reference to a class-name pattern.
   *
   * <p>Mutually exclusive with the following other properties defining annotation-name:
   *
   * <ul>
   *   <li>name
   *   <li>constant
   * </ul>
   *
   * <p>If none are specified the default is to match any annotation name.
   *
   * @return The class-name pattern that defines the annotation.
   */
  ClassNamePattern namePattern() default @ClassNamePattern(simpleName = "");

  /**
   * Specify which retention policies must be set for the annotations.
   *
   * <p>Matches annotations with matching retention policies
   *
   * @return Retention policies. By default {@code RetentionPolicy.RUNTIME}.
   */
  RetentionPolicy[] retention() default {RetentionPolicy.RUNTIME};
}