blob: 7475adf0413894ebf8c50973754e642aacb0894f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.impl (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.impl">
<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.impl" class="title">Package org.apache.logging.log4j.core.impl</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.23.0")
</span>package <span class="element-name">org.apache.logging.log4j.core.impl</span></div>
<section class="package-description" id="package-description">
<div class="block">Log4j 2 private implementation classes.</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</a></div>
<div class="col-last even-row-color">
<div class="block">Implementation of Log4j 2.</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="ContextAnchor.html" title="class in org.apache.logging.log4j.core.impl">ContextAnchor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Anchor for the ThreadContext.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ContextDataFactory.html" title="class in org.apache.logging.log4j.core.impl">ContextDataFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Factory for creating the StringMap instances used to initialize LogEvents' <a href="../LogEvent.html#getContextData()">context data</a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ContextDataInjectorFactory.html" title="class in org.apache.logging.log4j.core.impl">ContextDataInjectorFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Factory for ContextDataInjectors.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultLogEventFactory.html" title="class in org.apache.logging.log4j.core.impl">DefaultLogEventFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Always creates new LogEvent instances.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ExtendedClassInfo.html" title="class in org.apache.logging.log4j.core.impl">ExtendedClassInfo</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Class and package data used with a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link"><code>StackTraceElement</code></a> in a <a href="ExtendedStackTraceElement.html" title="class in org.apache.logging.log4j.core.impl"><code>ExtendedStackTraceElement</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExtendedStackTraceElement.html" title="class in org.apache.logging.log4j.core.impl">ExtendedStackTraceElement</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Wraps and extends the concept of the JRE's final class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link"><code>StackTraceElement</code></a> by adding more location information.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JdkMapAdapterStringMap.html" title="class in org.apache.logging.log4j.core.impl">JdkMapAdapterStringMap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Provides a read-only <code>StringMap</code> view of a <code>Map&lt;String, String&gt;</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Classes that use location information should implement this interface.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LocationAwareLogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LocationAwareLogEventFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Log4jContextFactory.html" title="class in org.apache.logging.log4j.core.impl">Log4jContextFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Factory to locate a ContextSelector and then load a LoggerContext.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Log4jLogEvent.html" title="class in org.apache.logging.log4j.core.impl">Log4jLogEvent</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implementation of a LogEvent.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Log4jLogEvent.Builder.html" title="class in org.apache.logging.log4j.core.impl">Log4jLogEvent.Builder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">LogEvent Builder helper class.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Log4jProvider.html" title="class in org.apache.logging.log4j.core.impl">Log4jProvider</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Binding for the Log4j API.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MementoMessage.html" title="class in org.apache.logging.log4j.core.impl">MementoMessage</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block"><em>Consider this class private.</em>
<a href="MementoMessage.html" title="class in org.apache.logging.log4j.core.impl"><code>MementoMessage</code></a> is intended to be used when we need to make an
immutable copy of a <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>Message</code></a> without forgetting the original
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html#getFormat()" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>Message.getFormat()</code></a> and <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html#getParameters()" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>Message.getParameters()</code></a> values.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MutableLogEvent.html" title="class in org.apache.logging.log4j.core.impl">MutableLogEvent</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Mutable implementation of the <code>LogEvent</code> interface.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReusableLogEventFactory.html" title="class in org.apache.logging.log4j.core.impl">ReusableLogEventFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Garbage-free LogEventFactory that reuses a single mutable log event.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThreadContextDataInjector.html" title="class in org.apache.logging.log4j.core.impl">ThreadContextDataInjector</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block"><code>ThreadContextDataInjector</code> contains a number of strategies for copying key-value pairs from the various
<code>ThreadContext</code> map implementations into a <code>StringMap</code>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ThreadContextDataInjector.ForCopyOnWriteThreadContextMap.html" title="class in org.apache.logging.log4j.core.impl">ThreadContextDataInjector.ForCopyOnWriteThreadContextMap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The <code>ContextDataInjector</code> used when the ThreadContextMap implementation is a copy-on-write
StringMap-based data structure.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThreadContextDataInjector.ForDefaultThreadContextMap.html" title="class in org.apache.logging.log4j.core.impl">ThreadContextDataInjector.ForDefaultThreadContextMap</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Default <code>ContextDataInjector</code> for the legacy <code>Map&lt;String, String&gt;</code>-based ThreadContext (which is
also the ThreadContext implementation used for web applications).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ThreadContextDataInjector.ForGarbageFreeThreadContextMap.html" title="class in org.apache.logging.log4j.core.impl">ThreadContextDataInjector.ForGarbageFreeThreadContextMap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The <code>ContextDataInjector</code> used when the ThreadContextMap implementation is a garbage-free
StringMap-based data structure.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThreadContextDataProvider.html" title="class in org.apache.logging.log4j.core.impl">ThreadContextDataProvider</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">ContextDataProvider for ThreadContext data.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ThrowableFormatOptions.html" title="class in org.apache.logging.log4j.core.impl">ThrowableFormatOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Contains options which control how a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link"><code>Throwable</code></a> pattern is formatted.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ThrowableProxy.html" title="class in org.apache.logging.log4j.core.impl">ThrowableProxy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Wraps a Throwable to add packaging information about each stack trace element.</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>