blob: d43b05a2b0929ea7d01fb3675ba4c34dccd02ddd [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:47 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.logging.log4j.core.config.plugins.visitors (Apache Log4j Core 2.13.3 API)</title>
<meta name="date" content="2020-05-10">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.logging.log4j.core.config.plugins.visitors (Apache Log4j Core 2.13.3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/validation/validators/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/logging/log4j/core/config/properties/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/config/plugins/visitors/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.logging.log4j.core.config.plugins.visitors</h1>
<div class="docSummary">
<div class="block">Visitor classes for extracting values from a Configuration or Node corresponding to a plugin annotation.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/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?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;</td>
<td class="colLast">
<div class="block">Visitor strategy for parsing data from a <a href="../../../../../../../../org/apache/logging/log4j/core/config/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>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/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?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;</td>
<td class="colLast">
<div class="block">Base class for PluginVisitor implementations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginAttributeVisitor</a></td>
<td class="colLast">
<div class="block">PluginVisitor implementation for <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginAttribute</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginBuilderAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginBuilderAttributeVisitor</a></td>
<td class="colLast">
<div class="block">PluginVisitor for PluginBuilderAttribute.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginConfigurationVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginConfigurationVisitor</a></td>
<td class="colLast">
<div class="block">PluginVisitor implementation for <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginConfiguration</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginElementVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginElementVisitor</a></td>
<td class="colLast">
<div class="block">PluginVisitor implementation for <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginElement</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginNodeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginNodeVisitor</a></td>
<td class="colLast">
<div class="block">PluginVisitor implementation for <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginNode.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginNode</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginValueVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginValueVisitor</a></td>
<td class="colLast">
<div class="block">PluginVisitor implementation for <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginValue.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginValue</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitors.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitors</a></td>
<td class="colLast">
<div class="block">Utility class to locate an appropriate <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors"><code>PluginVisitor</code></a> implementation for an annotation.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.logging.log4j.core.config.plugins.visitors Description">Package org.apache.logging.log4j.core.config.plugins.visitors Description</h2>
<div class="block">Visitor classes for extracting values from a Configuration or Node corresponding to a plugin annotation.
Visitor implementations must implement <a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/visitors/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="../../../../../../../../org/apache/logging/log4j/core/config/plugins/PluginVisitorStrategy.html" title="annotation in org.apache.logging.log4j.core.config.plugins"><code>PluginVisitorStrategy</code></a>.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/logging/log4j/core/config/plugins/validation/validators/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/logging/log4j/core/config/properties/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/config/plugins/visitors/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>