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 package org.apache.logging.log4j.core.config.plugins;
18
19 import java.lang.annotation.Documented;
20 import java.lang.annotation.ElementType;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24
25 import org.apache.logging.log4j.core.config.plugins.visitors.PluginElementVisitor;
26
27 /**
28 * Identifies a parameter as a Plugin and corresponds with an XML element (or equivalent) in configuration files.
29 */
30 @Documented
31 @Retention(RetentionPolicy.RUNTIME)
32 @Target({ElementType.PARAMETER, ElementType.FIELD})
33 @PluginVisitorStrategy(PluginElementVisitor.class)
34 public @interface PluginElement {
35
36 /**
37 * Identifies the case-insensitive element name (or attribute name) this corresponds with in a configuration file.
38 */
39 String value();
40 }