blob: afd9d6e2e21e33b2ff1a4b1829edb03a03be269f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RingBufferLogEvent (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.async, class: RingBufferLogEvent">
<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/RingBufferLogEvent.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><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&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.async</a></div>
<h1 title="Class RingBufferLogEvent" class="title">Class RingBufferLogEvent</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.async.RingBufferLogEvent</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code>, <code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code>, <code><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">Message</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ParameterVisitable.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ParameterVisitable</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ReusableMessage</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">StringBuilderFormattable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RingBufferLogEvent</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="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>, <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ReusableMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>, <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ParameterVisitable.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ParameterVisitable</a></span></div>
<div class="block">When the Disruptor is started, the RingBuffer is populated with event objects. These objects are then re-used during
the life of the RingBuffer.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../../serialized-form.html#org.apache.logging.log4j.core.async.RingBufferLogEvent">Serialized Form</a></li>
</ul>
</dd>
</dl>
</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>static final org.apache.logging.log4j.core.async.RingBufferLogEvent.Factory</code></div>
<div class="col-second even-row-color"><code><a href="#FACTORY" class="member-name-link">FACTORY</a></code></div>
<div class="col-last even-row-color">
<div class="block">The <code>EventFactory</code> for <code>RingBufferLogEvent</code>s.</div>
</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 two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RingBufferLogEvent</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</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-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>char</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#charAt(int)" class="member-name-link">charAt</a><wbr>(int&nbsp;index)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Release references held by ring buffer to allow objects to be garbage-collected.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createMemento()" class="member-name-link">createMemento</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates and returns a new immutable copy of this <code>RingBufferLogEvent</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(boolean)" class="member-name-link">execute</a><wbr>(boolean&nbsp;endOfBatch)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Event processor that reads the event from the ringbuffer can call this method.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;S&gt;&nbsp;void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)" class="member-name-link">forEachParameter</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ParameterConsumer.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ParameterConsumer</a>&lt;S&gt;&nbsp;action,
S&nbsp;state)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatTo(java.lang.StringBuilder)" class="member-name-link">formatTo</a><wbr>(<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;buffer)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/ReadOnlyStringMap.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">ReadOnlyStringMap</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContextData()" class="member-name-link">getContextData</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the <code>ReadOnlyStringMap</code> object holding context data key-value pairs.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>&lt;<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>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContextMap()" class="member-name-link">getContextMap</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the context map (also know as Mapped Diagnostic Context or MDC).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/ThreadContext.ContextStack.html" title="class or interface in org.apache.logging.log4j" class="external-link">ThreadContext.ContextStack</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContextStack()" class="member-name-link">getContextStack</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the context stack (also known as Nested Diagnostic Context or NDC).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#getFormat()" class="member-name-link">getFormat</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFormattedMessage()" class="member-name-link">getFormattedMessage</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../time/Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInstant()" class="member-name-link">getInstant</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the Instant when the message was logged.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLevel()" class="member-name-link">getLevel</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the level.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#getLoggerFqcn()" class="member-name-link">getLoggerFqcn</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the fully qualified class name of the caller of the logging API.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLoggerName()" class="member-name-link">getLoggerName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the logger name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMarker()" class="member-name-link">getMarker</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the Marker associated with the event.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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">Message</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMessage()" class="member-name-link">getMessage</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the message associated with the event.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNanoTime()" class="member-name-link">getNanoTime</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the value of the running Java Virtual Machine's high-resolution time source when this event was created,
or a dummy value if it is known that this value will not be used downstream.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>short</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParameterCount()" class="member-name-link">getParameterCount</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><code><a href="#getParameters()" class="member-name-link">getParameters</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSource()" class="member-name-link">getSource</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the source of logging request.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThreadId()" class="member-name-link">getThreadId</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the thread ID.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThreadName()" class="member-name-link">getThreadName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the thread name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThreadPriority()" class="member-name-link">getThreadPriority</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the thread priority.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThrowable()" class="member-name-link">getThrowable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThrown()" class="member-name-link">getThrown</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets throwable associated with logging request.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../impl/ThrowableProxy.html" title="class in org.apache.logging.log4j.core.impl">ThrowableProxy</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThrownProxy()" class="member-name-link">getThrownProxy</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets throwable proxy associated with logging request.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeMillis()" class="member-name-link">getTimeMillis</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets event time in milliseconds since midnight, January 1, 1970 UTC.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initializeBuilder(org.apache.logging.log4j.core.impl.Log4jLogEvent.Builder)" class="member-name-link">initializeBuilder</a><wbr>(<a href="../impl/Log4jLogEvent.Builder.html" title="class in org.apache.logging.log4j.core.impl">Log4jLogEvent.Builder</a>&nbsp;builder)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initializes the specified <code>Log4jLogEvent.Builder</code> from this <code>RingBufferLogEvent</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEndOfBatch()" class="member-name-link">isEndOfBatch</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns <code>true</code> if this event is the end of a batch, <code>false</code> otherwise.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIncludeLocation()" class="member-name-link">isIncludeLocation</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns whether the source of the logging request is required downstream.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPopulated()" class="member-name-link">isPopulated</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#length()" class="member-name-link">length</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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">Message</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#memento()" class="member-name-link">memento</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEndOfBatch(boolean)" class="member-name-link">setEndOfBatch</a><wbr>(boolean&nbsp;endOfBatch)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets whether this event is the last one in a batch.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIncludeLocation(boolean)" class="member-name-link">setIncludeLocation</a><wbr>(boolean&nbsp;includeLocation)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets whether the source of the logging request is required downstream.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValues(org.apache.logging.log4j.core.async.AsyncLogger,java.lang.String,org.apache.logging.log4j.Marker,java.lang.String,org.apache.logging.log4j.Level,org.apache.logging.log4j.message.Message,java.lang.Throwable,org.apache.logging.log4j.util.StringMap,org.apache.logging.log4j.ThreadContext.ContextStack,long,java.lang.String,int,java.lang.StackTraceElement,org.apache.logging.log4j.core.util.Clock,org.apache.logging.log4j.core.util.NanoClock)" class="member-name-link">setValues</a><wbr>(<a href="AsyncLogger.html" title="class in org.apache.logging.log4j.core.async">AsyncLogger</a>&nbsp;anAsyncLogger,
<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;aLoggerName,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a>&nbsp;aMarker,
<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;theFqcn,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a>&nbsp;aLevel,
<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">Message</a>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;aThrowable,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringMap.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">StringMap</a>&nbsp;mutableContextData,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/ThreadContext.ContextStack.html" title="class or interface in org.apache.logging.log4j" class="external-link">ThreadContext.ContextStack</a>&nbsp;aContextStack,
long&nbsp;threadId,
<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;threadName,
int&nbsp;threadPriority,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a>&nbsp;aLocation,
<a href="../util/Clock.html" title="interface in org.apache.logging.log4j.core.util">Clock</a>&nbsp;clock,
<a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util">NanoClock</a>&nbsp;nanoClock)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subSequence(int,int)" class="member-name-link">subSequence</a><wbr>(int&nbsp;start,
int&nbsp;end)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#swapParameters(java.lang.Object%5B%5D)" class="member-name-link">swapParameters</a><wbr>(<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>[]&nbsp;emptyReplacement)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Replaces this ReusableMessage's parameter array with the specified value and return the original array</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toImmutable()" class="member-name-link">toImmutable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns an immutable version of this log event, which MAY BE a copy of this event.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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-java.lang.CharSequence">Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#chars--" title="class or interface in java.lang" class="external-link">chars</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#codePoints--" title="class or interface in java.lang" class="external-link">codePoints</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#toString--" title="class or interface in java.lang" class="external-link">toString</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="FACTORY">
<h3>FACTORY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">org.apache.logging.log4j.core.async.RingBufferLogEvent.Factory</span>&nbsp;<span class="element-name">FACTORY</span></div>
<div class="block">The <code>EventFactory</code> for <code>RingBufferLogEvent</code>s.</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="&lt;init&gt;()">
<h3>RingBufferLogEvent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RingBufferLogEvent</span>()</div>
</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="setValues(org.apache.logging.log4j.core.async.AsyncLogger,java.lang.String,org.apache.logging.log4j.Marker,java.lang.String,org.apache.logging.log4j.Level,org.apache.logging.log4j.message.Message,java.lang.Throwable,org.apache.logging.log4j.util.StringMap,org.apache.logging.log4j.ThreadContext.ContextStack,long,java.lang.String,int,java.lang.StackTraceElement,org.apache.logging.log4j.core.util.Clock,org.apache.logging.log4j.core.util.NanoClock)">
<h3>setValues</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setValues</span><wbr><span class="parameters">(<a href="AsyncLogger.html" title="class in org.apache.logging.log4j.core.async">AsyncLogger</a>&nbsp;anAsyncLogger,
<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;aLoggerName,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a>&nbsp;aMarker,
<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;theFqcn,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a>&nbsp;aLevel,
<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">Message</a>&nbsp;msg,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a>&nbsp;aThrowable,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringMap.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">StringMap</a>&nbsp;mutableContextData,
<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/ThreadContext.ContextStack.html" title="class or interface in org.apache.logging.log4j" class="external-link">ThreadContext.ContextStack</a>&nbsp;aContextStack,
long&nbsp;threadId,
<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;threadName,
int&nbsp;threadPriority,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a>&nbsp;aLocation,
<a href="../util/Clock.html" title="interface in org.apache.logging.log4j.core.util">Clock</a>&nbsp;clock,
<a href="../util/NanoClock.html" title="interface in org.apache.logging.log4j.core.util">NanoClock</a>&nbsp;nanoClock)</span></div>
</section>
</li>
<li>
<section class="detail" id="toImmutable()">
<h3>toImmutable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></span>&nbsp;<span class="element-name">toImmutable</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#toImmutable()">LogEvent</a></code></span></div>
<div class="block">Returns an immutable version of this log event, which MAY BE a copy of this event.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#toImmutable()">toImmutable</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>an immutable version of this log event</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute(boolean)">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span><wbr><span class="parameters">(boolean&nbsp;endOfBatch)</span></div>
<div class="block">Event processor that reads the event from the ringbuffer can call this method.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>endOfBatch</code> - flag to indicate if this is the last event in a batch from the RingBuffer</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isPopulated()">
<h3>isPopulated</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isPopulated</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if this event is populated with data, <code>false</code> otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isEndOfBatch()">
<h3>isEndOfBatch</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isEndOfBatch</span>()</div>
<div class="block">Returns <code>true</code> if this event is the end of a batch, <code>false</code> otherwise.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#isEndOfBatch()">isEndOfBatch</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd><code>true</code> if this event is the end of a batch, <code>false</code> otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setEndOfBatch(boolean)">
<h3>setEndOfBatch</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setEndOfBatch</span><wbr><span class="parameters">(boolean&nbsp;endOfBatch)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#setEndOfBatch(boolean)">LogEvent</a></code></span></div>
<div class="block">Sets whether this event is the last one in a batch. Used by asynchronous Loggers and Appenders to signal to
buffered downstream components when to flush to disk, as a more efficient alternative to the
<code>immediateFlush=true</code> configuration.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#setEndOfBatch(boolean)">setEndOfBatch</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Parameters:</dt>
<dd><code>endOfBatch</code> - <code>true</code> if this event is the last one in a batch, <code>false</code> otherwise.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isIncludeLocation()">
<h3>isIncludeLocation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isIncludeLocation</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#isIncludeLocation()">LogEvent</a></code></span></div>
<div class="block">Returns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use
this flag to determine whether to take a <code>StackTrace</code> snapshot or not before handing off this event to
another thread.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#isIncludeLocation()">isIncludeLocation</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd><code>true</code> if the source of the logging request is required downstream, <code>false</code> otherwise.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../LogEvent.html#getSource()"><code>LogEvent.getSource()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setIncludeLocation(boolean)">
<h3>setIncludeLocation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setIncludeLocation</span><wbr><span class="parameters">(boolean&nbsp;includeLocation)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#setIncludeLocation(boolean)">LogEvent</a></code></span></div>
<div class="block">Sets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use
this flag to determine whether to take a <code>StackTrace</code> snapshot or not before handing off this event to
another thread.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#setIncludeLocation(boolean)">setIncludeLocation</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Parameters:</dt>
<dd><code>includeLocation</code> - <code>true</code> if the source of the logging request is required downstream, <code>false</code>
otherwise.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../LogEvent.html#getSource()"><code>LogEvent.getSource()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLoggerName()">
<h3>getLoggerName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getLoggerName</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getLoggerName()">LogEvent</a></code></span></div>
<div class="block">Gets the logger name.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getLoggerName()">getLoggerName</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>logger name, may be <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMarker()">
<h3>getMarker</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a></span>&nbsp;<span class="element-name">getMarker</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getMarker()">LogEvent</a></code></span></div>
<div class="block">Gets the Marker associated with the event.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getMarker()">getMarker</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>Marker or <code>null</code> if no Marker was defined on this LogEvent</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLoggerFqcn()">
<h3>getLoggerFqcn</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getLoggerFqcn</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getLoggerFqcn()">LogEvent</a></code></span></div>
<div class="block">Returns the fully qualified class name of the caller of the logging API.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getLoggerFqcn()">getLoggerFqcn</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>The fully qualified class name of the caller.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLevel()">
<h3>getLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a></span>&nbsp;<span class="element-name">getLevel</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getLevel()">LogEvent</a></code></span></div>
<div class="block">Gets the level.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getLevel()">getLevel</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>level.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMessage()">
<h3>getMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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">Message</a></span>&nbsp;<span class="element-name">getMessage</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getMessage()">LogEvent</a></code></span></div>
<div class="block">Gets the message associated with the event.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getMessage()">getMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>message.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFormattedMessage()">
<h3>getFormattedMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getFormattedMessage</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html#getFormattedMessage()" title="class or interface in org.apache.logging.log4j.message" class="external-link">getFormattedMessage</a></code>&nbsp;in interface&nbsp;<code><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">Message</a></code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html#getFormattedMessage()" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>Message.getFormattedMessage()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFormat()">
<h3>getFormat</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getFormat</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><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">getFormat</a></code>&nbsp;in interface&nbsp;<code><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">Message</a></code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><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></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getParameters()">
<h3>getParameters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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">getParameters</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><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">getParameters</a></code>&nbsp;in interface&nbsp;<code><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">Message</a></code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><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></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThrowable()">
<h3>getThrowable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span>&nbsp;<span class="element-name">getThrowable</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html#getThrowable()" title="class or interface in org.apache.logging.log4j.message" class="external-link">getThrowable</a></code>&nbsp;in interface&nbsp;<code><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">Message</a></code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html#getThrowable()" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>Message.getThrowable()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="formatTo(java.lang.StringBuilder)">
<h3>formatTo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">formatTo</span><wbr><span class="parameters">(<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;buffer)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)" title="class or interface in org.apache.logging.log4j.util" class="external-link">formatTo</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">StringBuilderFormattable</a></code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)" title="class or interface in org.apache.logging.log4j.util" class="external-link"><code>StringBuilderFormattable.formatTo(StringBuilder)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="swapParameters(java.lang.Object[])">
<h3>swapParameters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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">swapParameters</span><wbr><span class="parameters">(<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>[]&nbsp;emptyReplacement)</span></div>
<div class="block">Replaces this ReusableMessage's parameter array with the specified value and return the original array</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html#swapParameters(java.lang.Object%5B%5D)" title="class or interface in org.apache.logging.log4j.message" class="external-link">swapParameters</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ReusableMessage</a></code></dd>
<dt>Parameters:</dt>
<dd><code>emptyReplacement</code> - the parameter array that can be used for subsequent uses of this reusable message</dd>
<dt>Returns:</dt>
<dd>the original parameter array</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html#swapParameters(java.lang.Object%5B%5D)" title="class or interface in org.apache.logging.log4j.message" class="external-link"><code>ReusableMessage.swapParameters(Object[])</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getParameterCount()">
<h3>getParameterCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">short</span>&nbsp;<span class="element-name">getParameterCount</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html#getParameterCount()" title="class or interface in org.apache.logging.log4j.message" class="external-link">getParameterCount</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ReusableMessage</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)">
<h3 id="forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,java.lang.Object)">forEachParameter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;S&gt;</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">forEachParameter</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ParameterConsumer.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ParameterConsumer</a>&lt;S&gt;&nbsp;action,
S&nbsp;state)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ParameterVisitable.html#forEachParameter(org.apache.logging.log4j.message.ParameterConsumer,S)" title="class or interface in org.apache.logging.log4j.message" class="external-link">forEachParameter</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ParameterVisitable.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ParameterVisitable</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="memento()">
<h3>memento</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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">Message</a></span>&nbsp;<span class="element-name">memento</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html#memento()" title="class or interface in org.apache.logging.log4j.message" class="external-link">memento</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/ReusableMessage.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">ReusableMessage</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="length()">
<h3>length</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">length</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#length--" title="class or interface in java.lang" class="external-link">length</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="charAt(int)">
<h3>charAt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">char</span>&nbsp;<span class="element-name">charAt</span><wbr><span class="parameters">(int&nbsp;index)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#charAt-int-" title="class or interface in java.lang" class="external-link">charAt</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="subSequence(int,int)">
<h3>subSequence</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></span>&nbsp;<span class="element-name">subSequence</span><wbr><span class="parameters">(int&nbsp;start,
int&nbsp;end)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html#subSequence-int-int-" title="class or interface in java.lang" class="external-link">subSequence</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThrown()">
<h3>getThrown</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span>&nbsp;<span class="element-name">getThrown</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getThrown()">LogEvent</a></code></span></div>
<div class="block">Gets throwable associated with logging request.
<p>Convenience method for <code>ThrowableProxy.getThrowable();</code></p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getThrown()">getThrown</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>throwable, may be null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThrownProxy()">
<h3>getThrownProxy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../impl/ThrowableProxy.html" title="class in org.apache.logging.log4j.core.impl">ThrowableProxy</a></span>&nbsp;<span class="element-name">getThrownProxy</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getThrownProxy()">LogEvent</a></code></span></div>
<div class="block">Gets throwable proxy associated with logging request.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getThrownProxy()">getThrownProxy</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>throwable, may be null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContextData()">
<h3>getContextData</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/ReadOnlyStringMap.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">ReadOnlyStringMap</a></span>&nbsp;<span class="element-name">getContextData</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getContextData()">LogEvent</a></code></span></div>
<div class="block">Returns the <code>ReadOnlyStringMap</code> object holding context data key-value pairs.
<p>
Context data (also known as Mapped Diagnostic Context or MDC) is data that is set by the application to be
included in all subsequent log events. The default source for context data is the <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/ThreadContext.html" title="class or interface in org.apache.logging.log4j" class="external-link"><code>ThreadContext</code></a> (and
<a href="https://logging.apache.org/log4j/2.x/manual/configuration.html#PropertySubstitution">properties</a>
configured on the Logger that logged the event), but users can configure a custom <a href="../ContextDataInjector.html" title="interface in org.apache.logging.log4j.core"><code>ContextDataInjector</code></a>
to inject key-value pairs from any arbitrary source.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getContextData()">getContextData</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>the <code>ReadOnlyStringMap</code> object holding context data key-value pairs</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../ContextDataInjector.html" title="interface in org.apache.logging.log4j.core"><code>ContextDataInjector</code></a></li>
<li><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/ThreadContext.html" title="class or interface in org.apache.logging.log4j" class="external-link"><code>ThreadContext</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContextMap()">
<h3>getContextMap</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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>&lt;<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>&gt;</span>&nbsp;<span class="element-name">getContextMap</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getContextMap()">LogEvent</a></code></span></div>
<div class="block">Gets the context map (also know as Mapped Diagnostic Context or MDC).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getContextMap()">getContextMap</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>The context map, never <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContextStack()">
<h3>getContextStack</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/ThreadContext.ContextStack.html" title="class or interface in org.apache.logging.log4j" class="external-link">ThreadContext.ContextStack</a></span>&nbsp;<span class="element-name">getContextStack</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getContextStack()">LogEvent</a></code></span></div>
<div class="block">Gets the context stack (also known as Nested Diagnostic Context or NDC).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getContextStack()">getContextStack</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>The context stack, never <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThreadId()">
<h3>getThreadId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getThreadId</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getThreadId()">LogEvent</a></code></span></div>
<div class="block">Gets the thread ID.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getThreadId()">getThreadId</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>thread ID.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThreadName()">
<h3>getThreadName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getThreadName</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getThreadName()">LogEvent</a></code></span></div>
<div class="block">Gets the thread name.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getThreadName()">getThreadName</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>thread name, may be null.
TODO guess this could go into a thread context object too. (RG) Why?</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThreadPriority()">
<h3>getThreadPriority</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getThreadPriority</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getThreadPriority()">LogEvent</a></code></span></div>
<div class="block">Gets the thread priority.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getThreadPriority()">getThreadPriority</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>thread priority.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSource()">
<h3>getSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a></span>&nbsp;<span class="element-name">getSource</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getSource()">LogEvent</a></code></span></div>
<div class="block">Gets the source of logging request.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getSource()">getSource</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>source of logging request, may be null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTimeMillis()">
<h3>getTimeMillis</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getTimeMillis</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getTimeMillis()">LogEvent</a></code></span></div>
<div class="block">Gets event time in milliseconds since midnight, January 1, 1970 UTC.
Use <a href="../LogEvent.html#getInstant()"><code>LogEvent.getInstant()</code></a> to get higher precision timestamp information if available on this platform.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getTimeMillis()">getTimeMillis</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>the milliseconds component of this log event's <a href="../LogEvent.html#getInstant()">timestamp</a></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#currentTimeMillis--" title="class or interface in java.lang" class="external-link"><code>System.currentTimeMillis()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getInstant()">
<h3>getInstant</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../time/Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></span>&nbsp;<span class="element-name">getInstant</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getInstant()">LogEvent</a></code></span></div>
<div class="block">Returns the Instant when the message was logged.
<p>
<b>Caution</b>: if this <code>LogEvent</code> implementation is mutable and reused for multiple consecutive log messages,
then the <code>Instant</code> object returned by this method is also mutable and reused.
Client code should not keep a reference to the returned object but make a copy instead.
</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getInstant()">getInstant</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>the <code>Instant</code> holding Instant details for this log event</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNanoTime()">
<h3>getNanoTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getNanoTime</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../LogEvent.html#getNanoTime()">LogEvent</a></code></span></div>
<div class="block">Returns the value of the running Java Virtual Machine's high-resolution time source when this event was created,
or a dummy value if it is known that this value will not be used downstream.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../LogEvent.html#getNanoTime()">getNanoTime</a></code>&nbsp;in interface&nbsp;<code><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></code></dd>
<dt>Returns:</dt>
<dd>The value of the running Java Virtual Machine's high-resolution time source when this event was created.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clear()">
<h3>clear</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">clear</span>()</div>
<div class="block">Release references held by ring buffer to allow objects to be garbage-collected.</div>
</section>
</li>
<li>
<section class="detail" id="createMemento()">
<h3>createMemento</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></span>&nbsp;<span class="element-name">createMemento</span>()</div>
<div class="block">Creates and returns a new immutable copy of this <code>RingBufferLogEvent</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a new immutable copy of the data in this <code>RingBufferLogEvent</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="initializeBuilder(org.apache.logging.log4j.core.impl.Log4jLogEvent.Builder)">
<h3>initializeBuilder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">initializeBuilder</span><wbr><span class="parameters">(<a href="../impl/Log4jLogEvent.Builder.html" title="class in org.apache.logging.log4j.core.impl">Log4jLogEvent.Builder</a>&nbsp;builder)</span></div>
<div class="block">Initializes the specified <code>Log4jLogEvent.Builder</code> from this <code>RingBufferLogEvent</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>builder</code> - the builder whose fields to populate</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>