2.x/javadoc/log4j-core/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.html - logging-log4j-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>PluginVisitor (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, interface: PluginVisitor">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <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="class-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><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/PluginVisitor.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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</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">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.config.plugins.visitors</a></div>
 <h1 title="Interface PluginVisitor" class="title">Interface PluginVisitor&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;</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>A</code> - the Annotation type.</dd>
 </dl>
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="AbstractPluginVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">AbstractPluginVisitor</a></code>, <code><a href="PluginAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginAttributeVisitor</a></code>, <code><a href="PluginBuilderAttributeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginBuilderAttributeVisitor</a></code>, <code><a href="PluginConfigurationVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginConfigurationVisitor</a></code>, <code><a href="PluginElementVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginElementVisitor</a></code>, <code><a href="PluginLoggerContextVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginLoggerContextVisitor</a></code>, <code><a href="PluginNodeVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginNodeVisitor</a></code>, <code><a href="PluginValueVisitor.html" title="class in org.apache.logging.log4j.core.config.plugins.visitors">PluginValueVisitor</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">PluginVisitor&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;</span></div>
 <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. Implementations must be constructable using the default constructor.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAliases(java.lang.String...)" class="member-name-link">setAliases</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;aliases)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Sets the list of aliases to use for this visit.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAnnotation(java.lang.annotation.Annotation)" class="member-name-link">setAnnotation</a><wbr>(<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>&nbsp;annotation)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Sets the Annotation to be used for this.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setConversionType(java.lang.Class)" class="member-name-link">setConversionType</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&nbsp;conversionType)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Sets the class to convert the plugin value to on this visit.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMember(java.lang.reflect.Member)" class="member-name-link">setMember</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect" class="external-link">Member</a>&nbsp;member)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Sets the Member that this visitor is being used for injection upon.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setStrSubstitutor(org.apache.logging.log4j.core.lookup.StrSubstitutor)" class="member-name-link">setStrSubstitutor</a><wbr>(<a href="../../../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;substitutor)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Sets the StrSubstitutor to use for converting raw strings before type conversion.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)" class="member-name-link">visit</a><wbr>(<a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration,
  <a href="../../Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>&nbsp;node,
  <a href="../../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;log)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Visits a Node to obtain a value for constructing a Plugin object.</div>
 </div>
 </div>
 </div>
 </div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="setAnnotation(java.lang.annotation.Annotation)">
 <h3>setAnnotation</h3>
 <div class="member-signature"><span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</span>&nbsp;<span class="element-name">setAnnotation</span><wbr><span class="parameters">(<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>&nbsp;annotation)</span></div>
 <div class="block">Sets the Annotation to be used for this. If the given Annotation is not compatible with this class's type, then
  it is ignored.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>annotation</code> - the Annotation instance.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code>.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is <code>null</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setAliases(java.lang.String...)">
 <h3>setAliases</h3>
 <div class="member-signature"><span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</span>&nbsp;<span class="element-name">setAliases</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;aliases)</span></div>
 <div class="block">Sets the list of aliases to use for this visit. No aliases are required, however.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>aliases</code> - the list of aliases to use.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setConversionType(java.lang.Class)">
 <h3>setConversionType</h3>
 <div class="member-signature"><span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</span>&nbsp;<span class="element-name">setConversionType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&nbsp;conversionType)</span></div>
 <div class="block">Sets the class to convert the plugin value to on this visit. This should correspond with a class obtained from
  a factory method or builder class field. Not all PluginVisitor implementations may need this value.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>conversionType</code> - the type to convert the plugin string to (if applicable).</dd>
 <dt>Returns:</dt>
 <dd><code>this</code>.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is <code>null</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setStrSubstitutor(org.apache.logging.log4j.core.lookup.StrSubstitutor)">
 <h3>setStrSubstitutor</h3>
 <div class="member-signature"><span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</span>&nbsp;<span class="element-name">setStrSubstitutor</span><wbr><span class="parameters">(<a href="../../../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;substitutor)</span></div>
 <div class="block">Sets the StrSubstitutor to use for converting raw strings before type conversion. Generally obtained from a
  <a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config"><code>Configuration</code></a>.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>substitutor</code> - the StrSubstitutor to use on plugin values.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code>.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is <code>null</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setMember(java.lang.reflect.Member)">
 <h3>setMember</h3>
 <div class="member-signature"><span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a>&lt;<a href="PluginVisitor.html" title="type parameter in PluginVisitor">A</a>&gt;</span>&nbsp;<span class="element-name">setMember</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect" class="external-link">Member</a>&nbsp;member)</span></div>
 <div class="block">Sets the Member that this visitor is being used for injection upon. For instance, this could be the Field
  that is being used for injecting a value, or it could be the factory method being used to inject parameters
  into.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>member</code> - the member this visitor is parsing a value for.</dd>
 <dt>Returns:</dt>
 <dd><code>this</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="visit(org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)">
 <h3>visit</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration,
  <a href="../../Node.html" title="class in org.apache.logging.log4j.core.config">Node</a>&nbsp;node,
  <a href="../../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;log)</span></div>
 <div class="block">Visits a Node to obtain a value for constructing a Plugin object.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>configuration</code> - the current Configuration.</dd>
 <dd><code>node</code> - the current Node corresponding to the Plugin object being created.</dd>
 <dd><code>event</code> - the current LogEvent that caused this Plugin object to be made (optional).</dd>
 <dd><code>log</code> - the StringBuilder being used to build a debug message.</dd>
 <dt>Returns:</dt>
 <dd>the converted value to be used for Plugin creation.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </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>