| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractPluginVisitor (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, class: AbstractPluginVisitor"> |
| <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/AbstractPluginVisitor.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.logging.log4j.core.config.plugins.visitors</a></div> |
| <h1 title="Class AbstractPluginVisitor" class="title">Class AbstractPluginVisitor<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>></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.logging.log4j.core.config.plugins.visitors.AbstractPluginVisitor<A></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>A</code> - the Plugin annotation type.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><A></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><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 abstract class </span><span class="element-name type-name-label">AbstractPluginVisitor<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>></span> |
| <span class="extends-implements">extends <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> |
| implements <a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><A></span></div> |
| <div class="block">Base class for PluginVisitor implementations. Provides convenience methods as well as all method implementations |
| other than the <code>visit</code> method.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <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>[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#aliases" class="member-name-link">aliases</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#annotation" class="member-name-link">annotation</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <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><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#clazz" class="member-name-link">clazz</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <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><?></code></div> |
| <div class="col-second odd-row-color"><code><a href="#conversionType" class="member-name-link">conversionType</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Logger.html" title="class or interface in org.apache.logging.log4j" class="external-link">Logger</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#LOGGER" class="member-name-link">LOGGER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Status logger.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#member" class="member-name-link">member</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#substitutor" class="member-name-link">substitutor</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Class)" class="member-name-link">AbstractPluginVisitor</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><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>> clazz)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This constructor must be overridden by implementation classes as a no-arg constructor.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>protected <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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#convert(java.lang.String,java.lang.Object)" class="member-name-link">convert</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> value, |
| <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> defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts the given value into the configured type falling back to the provided default value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#removeAttributeValue(java.util.Map,java.lang.String,java.lang.String...)" class="member-name-link">removeAttributeValue</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<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>> attributes, |
| <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> name, |
| <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>... aliases)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Removes an Entry from a given Map using a key name and aliases for that key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>... someAliases)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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-tab4"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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> anAnnotation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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-tab4"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><?> aConversionType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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-tab4"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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> aMember)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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-tab4"><code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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> aSubstitutor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the StrSubstitutor to use for converting raw strings before type conversion.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor">Methods inherited from interface org.apache.logging.log4j.core.config.plugins.visitors.<a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a></h3> |
| <code><a href="PluginVisitor.html#visit(org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.config.Node,org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)">visit</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOGGER"> |
| <h3>LOGGER</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Logger.html" title="class or interface in org.apache.logging.log4j" class="external-link">Logger</a></span> <span class="element-name">LOGGER</span></div> |
| <div class="block">Status logger.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clazz"> |
| <h3>clazz</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><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><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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>></span> <span class="element-name">clazz</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="annotation"> |
| <h3>annotation</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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></span> <span class="element-name">annotation</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aliases"> |
| <h3>aliases</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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>[]</span> <span class="element-name">aliases</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conversionType"> |
| <h3>conversionType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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><?></span> <span class="element-name">conversionType</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="substitutor"> |
| <h3>substitutor</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">substitutor</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="member"> |
| <h3>member</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">member</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.Class)"> |
| <h3>AbstractPluginVisitor</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractPluginVisitor</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><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>> clazz)</span></div> |
| <div class="block">This constructor must be overridden by implementation classes as a no-arg constructor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - the annotation class this PluginVisitor is for.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ 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="modifiers">public</span> <span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></span> <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> anAnnotation)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PluginVisitor.html#setAnnotation(java.lang.annotation.Annotation)">PluginVisitor</a></code></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>Specified by:</dt> |
| <dd><code><a href="PluginVisitor.html#setAnnotation(java.lang.annotation.Annotation)">setAnnotation</a></code> in interface <code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>anAnnotation</code> - the Annotation instance.</dd> |
| <dt>Returns:</dt> |
| <dd><code>this</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAliases(java.lang.String...)"> |
| <h3>setAliases</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></span> <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>... someAliases)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PluginVisitor.html#setAliases(java.lang.String...)">PluginVisitor</a></code></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>Specified by:</dt> |
| <dd><code><a href="PluginVisitor.html#setAliases(java.lang.String...)">setAliases</a></code> in interface <code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>someAliases</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="modifiers">public</span> <span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></span> <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><?> aConversionType)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PluginVisitor.html#setConversionType(java.lang.Class)">PluginVisitor</a></code></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>Specified by:</dt> |
| <dd><code><a href="PluginVisitor.html#setConversionType(java.lang.Class)">setConversionType</a></code> in interface <code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>aConversionType</code> - the type to convert the plugin string to (if applicable).</dd> |
| <dt>Returns:</dt> |
| <dd><code>this</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="modifiers">public</span> <span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></span> <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> aSubstitutor)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PluginVisitor.html#setStrSubstitutor(org.apache.logging.log4j.core.lookup.StrSubstitutor)">PluginVisitor</a></code></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>Specified by:</dt> |
| <dd><code><a href="PluginVisitor.html#setStrSubstitutor(org.apache.logging.log4j.core.lookup.StrSubstitutor)">setStrSubstitutor</a></code> in interface <code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>aSubstitutor</code> - the StrSubstitutor to use on plugin values.</dd> |
| <dt>Returns:</dt> |
| <dd><code>this</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMember(java.lang.reflect.Member)"> |
| <h3>setMember</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</a>></span> <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> aMember)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PluginVisitor.html#setMember(java.lang.reflect.Member)">PluginVisitor</a></code></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>Specified by:</dt> |
| <dd><code><a href="PluginVisitor.html#setMember(java.lang.reflect.Member)">setMember</a></code> in interface <code><a href="PluginVisitor.html" title="interface in org.apache.logging.log4j.core.config.plugins.visitors">PluginVisitor</a><<a href="AbstractPluginVisitor.html" title="type parameter in AbstractPluginVisitor">A</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>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>aMember</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="removeAttributeValue(java.util.Map,java.lang.String,java.lang.String...)"> |
| <h3>removeAttributeValue</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><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></span> <span class="element-name">removeAttributeValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<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>> attributes, |
| <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> name, |
| <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>... aliases)</span></div> |
| <div class="block">Removes an Entry from a given Map using a key name and aliases for that key. Keys are case-insensitive.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>attributes</code> - the Map to remove an Entry from.</dd> |
| <dd><code>name</code> - the key name to look up.</dd> |
| <dd><code>aliases</code> - optional aliases of the key name to look up.</dd> |
| <dt>Returns:</dt> |
| <dd>the value corresponding to the given key or <code>null</code> if nonexistent.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convert(java.lang.String,java.lang.Object)"> |
| <h3>convert</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <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> <span class="element-name">convert</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> value, |
| <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> defaultValue)</span></div> |
| <div class="block">Converts the given value into the configured type falling back to the provided default value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - the value to convert.</dd> |
| <dd><code>defaultValue</code> - the fallback value to use in case of no value or an error.</dd> |
| <dt>Returns:</dt> |
| <dd>the converted value whether that be based on the given value or the default value.</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 © 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> |
