| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.logging.log4j.core.layout (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.layout"> |
| <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: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </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.layout" class="title">Package org.apache.logging.log4j.core.layout</h1> |
| </div> |
| <hr> |
| <div class="package-signature"><span class="annotations">@Export |
| @Version("2.20.1") |
| </span>package <span class="element-name">org.apache.logging.log4j.core.layout</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Log4j 2 Layout support. <a href="../Layout.html" title="interface in org.apache.logging.log4j.core"><code>Layout</code></a> plugins should use the |
| <a href="../config/plugins/Plugin.html#category()">plugin category</a> |
| <a href="../config/Node.html#CATEGORY"><code>Core</code></a> and the |
| <a href="../config/plugins/Plugin.html#elementType()">element type</a> |
| <a href="../Layout.html#ELEMENT_TYPE"><code>layout</code></a>.</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><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</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="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A superclass for Comma-Separated Value (CSV) layouts.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><T extends <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>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract base class for Layouts.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout.Builder</a><B extends <a href="AbstractLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout.Builder</a><B>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Subclasses can extend this abstract Builder.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract base class for Layouts that result in a String.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><B extends <a href="AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><B>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="AbstractStringLayout.Serializer2.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Variation of <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout"><code>AbstractStringLayout.Serializer</code></a> that avoids allocating temporary objects.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout">ByteBufferDestination</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">ByteBufferDestination is the destination that <a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout"><code>Encoder</code></a>s write binary data to.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ByteBufferDestinationHelper.html" title="class in org.apache.logging.log4j.core.layout">ByteBufferDestinationHelper</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Helper class for ByteBufferDestination implementors.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CsvLogEventLayout.html" title="class in org.apache.logging.log4j.core.layout">CsvLogEventLayout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A Comma-Separated Value (CSV) layout to log events.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CsvParameterLayout.html" title="class in org.apache.logging.log4j.core.layout">CsvParameterLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A Comma-Separated Value (CSV) layout to log event parameters.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Objects implementing the <code>Encoder</code> interface know how to convert an object to some binary representation and |
| write the result to a <code>ByteBuffer</code>, ideally without creating temporary objects.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GelfLayout.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Lays out events in the Graylog Extended Log Format (GELF) 1.1.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GelfLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout.Builder</a><B extends <a href="GelfLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout.Builder</a><B>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="GelfLayout.CompressionType.html" title="enum in org.apache.logging.log4j.core.layout">GelfLayout.CompressionType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HtmlLayout.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Outputs events as rows in an HTML table on an HTML page.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="HtmlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout.Builder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="HtmlLayout.FontSize.html" title="enum in org.apache.logging.log4j.core.layout">HtmlLayout.FontSize</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Possible font sizes</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JsonLayout.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Note: The JsonLayout should be considered to be deprecated.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JsonLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout.Builder</a><B extends <a href="JsonLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout.Builder</a><B>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="LevelPatternSelector.html" title="class in org.apache.logging.log4j.core.layout">LevelPatternSelector</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Selects the pattern to use based on the Level in the LogEvent.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LevelPatternSelector.Builder.html" title="class in org.apache.logging.log4j.core.layout">LevelPatternSelector.Builder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Custom MarkerPatternSelector builder.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="LockingStringBuilderEncoder.html" title="class in org.apache.logging.log4j.core.layout">LockingStringBuilderEncoder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Encoder for StringBuilders that locks on the ByteBufferDestination.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A LoggerFields container.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MarkerPatternSelector.html" title="class in org.apache.logging.log4j.core.layout">MarkerPatternSelector</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Selects the pattern to use based on the Marker in the LogEvent.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MarkerPatternSelector.Builder.html" title="class in org.apache.logging.log4j.core.layout">MarkerPatternSelector.Builder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Custom MarkerPatternSelector builder.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MessageLayout.html" title="class in org.apache.logging.log4j.core.layout">MessageLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Formats a <a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> in its <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> form.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A flexible layout configurable with pattern string.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Custom PatternLayout builder.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PatternLayout.SerializerBuilder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.SerializerBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="PatternMatch.html" title="class in org.apache.logging.log4j.core.layout">PatternMatch</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">PatternMatch configuration item.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PatternMatch.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternMatch.Builder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Allows different patterns to be used with the PatternLayout based on some selection criteria.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Formats a log event in accordance with RFC 5424.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Rfc5424Layout.Rfc5424LayoutBuilder.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout.Rfc5424LayoutBuilder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ScriptPatternSelector.html" title="class in org.apache.logging.log4j.core.layout">ScriptPatternSelector</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Selects the pattern to use based on the result of executing a Script.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ScriptPatternSelector.Builder.html" title="class in org.apache.logging.log4j.core.layout">ScriptPatternSelector.Builder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Custom ScriptPatternSelector builder.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SerializedLayout.html" title="class in org.apache.logging.log4j.core.layout">SerializedLayout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2">Deprecated. |
| <div class="deprecation-comment">Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StringBuilderEncoder.html" title="class in org.apache.logging.log4j.core.layout">StringBuilderEncoder</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Encoder for StringBuilders that uses ThreadLocals to avoid locking as much as possible.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SyslogLayout.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Formats a log event as a BSD Log record.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SyslogLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout.Builder</a><B extends <a href="SyslogLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout.Builder</a><B>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Builds a SyslogLayout.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TextEncoderHelper.html" title="class in org.apache.logging.log4j.core.layout">TextEncoderHelper</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Helper class to encode text to binary data without allocating temporary objects.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="XmlLayout.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Appends a series of <code>event</code> elements as defined in the <a href="log4j.dtd">log4j.dtd</a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="XmlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout.Builder</a><B extends <a href="XmlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout.Builder</a><B>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="YamlLayout.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Appends a series of YAML events as strings serialized as bytes.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="YamlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a><B extends <a href="YamlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a><B>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
