blob: e78a18f92f049e20d395a86172c5d99f3782aa80 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.config.plugins.visitors (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.visitors">
<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 evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
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.visitors" class="title">Package org.apache.logging.log4j.core.config.plugins.visitors</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.visitors</span></div>
<section class="package-description" id="package-description">
<div class="block">Visitor classes for extracting values from a Configuration or Node corresponding to a plugin annotation.
Visitor implementations must implement <a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors"><code>PluginVisitor</code></a>,
and the corresponding annotation must be annotated with
<a href="../PluginVisitorStrategy.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginVisitorStrategy</code></a>.</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.plugins</a></div>
<div class="col-last even-row-color">
<div class="block">Annotations for Log4j 2 plugins.</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>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<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-tab2"><a href="AbstractPluginVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">AbstractPluginVisitor</a>&lt;A extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link">Annotation</a>&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base class for PluginVisitor implementations.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PluginAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginAttributeVisitor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor implementation for <a href="../PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginAttribute</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PluginBuilderAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginBuilderAttributeVisitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor for PluginBuilderAttribute.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PluginConfigurationVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginConfigurationVisitor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor implementation for <a href="../PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginConfiguration</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PluginElementVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginElementVisitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor implementation for <a href="../PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginElement</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PluginLoggerContextVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginLoggerContextVisitor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor implementation for <a href="../PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginConfiguration</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PluginNodeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginNodeVisitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor implementation for <a href="../PluginNode.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginNode</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PluginValueVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginValueVisitor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">PluginVisitor implementation for <a href="../PluginValue.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginValue</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;A extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link">Annotation</a>&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Visitor strategy for parsing data from a <a href="../../Node.html" title="class in org.apache.logging.log4j.core.config"><code>Node</code></a>, doing any relevant type conversion, and returning a
parsed value for that variable.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PluginVisitors.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitors</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Utility class to locate an appropriate <a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors"><code>PluginVisitor</code></a> implementation for an annotation.</div>
</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>