blob: 8987d7c08a953a59de145a978a57103f97ed3ca6 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.config.plugins (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.logging.log4j.core.config.plugins">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package org.apache.logging.log4j.core.config.plugins" class="title">Package org.apache.logging.log4j.core.config.plugins</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.20.1")
</span>package <span class="element-name">org.apache.logging.log4j.core.config.plugins</span></div>
<section class="package-description" id="package-description">
<div class="block">Annotations for Log4j 2 plugins.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.logging.log4j.core.config</a></div>
<div class="col-last even-row-color">
<div class="block">Configuration of Log4j 2.</div>
</div>
<div class="col-first odd-row-color"><a href="convert/package-summary.html">org.apache.logging.log4j.core.config.plugins.convert</a></div>
<div class="col-last odd-row-color">
<div class="block">TypeConverter plugins for converter strings into various types.</div>
</div>
<div class="col-first even-row-color"><a href="processor/package-summary.html">org.apache.logging.log4j.core.config.plugins.processor</a></div>
<div class="col-last even-row-color">
<div class="block">Java annotation processor for pre-scanning Log4j 2 plugins.</div>
</div>
<div class="col-first odd-row-color"><a href="util/package-summary.html">org.apache.logging.log4j.core.config.plugins.util</a></div>
<div class="col-last odd-row-color">
<div class="block">Utility and manager classes for Log4j 2 plugins.</div>
</div>
<div class="col-first even-row-color"><a href="validation/package-summary.html">org.apache.logging.log4j.core.config.plugins.validation</a></div>
<div class="col-last even-row-color">
<div class="block">Constraint validators for plugin factory methods.</div>
</div>
<div class="col-first odd-row-color"><a href="visitors/package-summary.html">org.apache.logging.log4j.core.config.plugins.visitors</a></div>
<div class="col-last odd-row-color">
<div class="block">Visitor classes for extracting values from a Configuration or Node corresponding to a plugin annotation.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="caption"><span>Annotation Types</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">Plugin</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Annotation that identifies a Class as a Plugin.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PluginAliases.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginAliases</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Identifies a list of aliases for a <a href="Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>Plugin</code></a>, <a href="PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginAttribute</code></a>, or <a href="PluginBuilderAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginBuilderAttribute</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginAttribute</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Identifies a Plugin Attribute and its default value.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PluginBuilderAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginBuilderAttribute</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Marks a field as a Plugin Attribute.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginBuilderFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Marks a method as a factory for custom Plugin builders.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginConfiguration</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Identifies a parameter or field as a Configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginElement</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Identifies a parameter as a Plugin and corresponds with an XML element (or equivalent) in configuration files.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Identifies a Method as the factory to create the plugin.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="PluginLoggerContext.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginLoggerContext</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Identifies a parameter or field as a LoggerContext.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PluginNode.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginNode</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Identifies a Plugin configuration Node.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="PluginValue.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginValue</a></div>
<div class="col-last even-row-color class-summary class-summary-tab7">
<div class="block">Identifies a parameter as a value.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PluginVisitorStrategy.html" title="annotation in org.apache.logging.log4j.core.config.plugins">PluginVisitorStrategy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">Meta-annotation to denote the class name to use that implements
<a href="visitors/PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors"><code>PluginVisitor</code></a> for the annotated annotation.</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>