View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements. See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License. You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.logging.log4j.core.config.plugins;
    19
    20  import java.lang.annotation.Annotation;
    21  import java.lang.annotation.Documented;
    22  import java.lang.annotation.ElementType;
    23  import java.lang.annotation.Retention;
    24  import java.lang.annotation.RetentionPolicy;
    25  import java.lang.annotation.Target;
    26
    27  import org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor;
    28
    29  /**
    30   * Meta-annotation to denote the class name to use that implements
    31   * {@link org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor} for the annotated annotation.
    32   */
    33  @Documented
    34  @Retention(RetentionPolicy.RUNTIME)
    35  @Target(ElementType.ANNOTATION_TYPE)
    36  public @interface PluginVisitorStrategy {
    37
    38      /**
    39       * The class to use that implements {@link org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor}
    40       * for the given annotation. The generic type in {@code PluginVisitor} should match the annotation this annotation
    41       * is applied to.
    42       */
    43      Class<? extends PluginVisitor<? extends Annotation>> value();
    44  }