| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Interface org.apache.logging.log4j.core.layout.Encoder (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="use: package: org.apache.logging.log4j.core.layout, interface: Encoder"> |
| <meta name="generator" content="javadoc/ClassUseWriter"> |
| <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-use-page"> |
| <script type="text/javascript">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><a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Class</a></li> |
| <li class="nav-bar-cell1-rev">Use</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#use">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <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="Uses of Interface org.apache.logging.log4j.core.layout.Encoder" class="title">Uses of Interface<br>org.apache.logging.log4j.core.layout.Encoder</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></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="#org.apache.logging.log4j.core">org.apache.logging.log4j.core</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implementation of Log4j 2.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Log4j 2 Layout support.</div> |
| </div> |
| </div> |
| <section class="class-uses"> |
| <ul class="block-list"> |
| <li> |
| <section class="detail" id="org.apache.logging.log4j.core"> |
| <h2>Uses of <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a> in <a href="../../package-summary.html">org.apache.logging.log4j.core</a></h2> |
| <div class="caption"><span>Subinterfaces of <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a> in <a href="../../package-summary.html">org.apache.logging.log4j.core</a></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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>interface </code></div> |
| <div class="col-second even-row-color"><code><a href="../../Layout.html" class="type-name-link" title="interface in org.apache.logging.log4j.core">Layout</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>></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Lays out a <a href="../../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> in different formats.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="../../StringLayout.html" class="type-name-link" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Instantiates the <a href="../../Layout.html" title="interface in org.apache.logging.log4j.core"><code>Layout</code></a> type for String-based layouts.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.logging.log4j.core.layout"> |
| <h2>Uses of <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a> in <a href="../package-summary.html">org.apache.logging.log4j.core.layout</a></h2> |
| <div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.logging.log4j.core.layout</a> that implement <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="../AbstractCsvLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A superclass for Comma-Separated Value (CSV) layouts.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../AbstractLayout.html" class="type-name-link" 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>></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Abstract base class for Layouts.</div> |
| </div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="../AbstractStringLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Abstract base class for Layouts that result in a String.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../CsvLogEventLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">CsvLogEventLayout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">A Comma-Separated Value (CSV) layout to log events.</div> |
| </div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="../CsvParameterLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">CsvParameterLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A Comma-Separated Value (CSV) layout to log event parameters.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../GelfLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">GelfLayout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Lays out events in the Graylog Extended Log Format (GELF) 1.1.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final class </code></div> |
| <div class="col-second even-row-color"><code><a href="../HtmlLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">HtmlLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Outputs events as rows in an HTML table on an HTML page.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../JsonLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">JsonLayout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Note: The JsonLayout should be considered to be deprecated.</div> |
| </div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="../LockingStringBuilderEncoder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">LockingStringBuilderEncoder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Encoder for StringBuilders that locks on the ByteBufferDestination.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../MessageLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">MessageLayout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <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 even-row-color"><code>final class </code></div> |
| <div class="col-second even-row-color"><code><a href="../PatternLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A flexible layout configurable with pattern string.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../Rfc5424Layout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Formats a log event in accordance with RFC 5424.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final class </code></div> |
| <div class="col-second even-row-color"><code><a href="../SerializedLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">SerializedLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color"><code>class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../StringBuilderEncoder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">StringBuilderEncoder</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Encoder for StringBuilders that uses ThreadLocals to avoid locking as much as possible.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final class </code></div> |
| <div class="col-second even-row-color"><code><a href="../SyslogLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">SyslogLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Formats a log event as a BSD Log record.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../XmlLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">XmlLayout</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Appends a series of <code>event</code> elements as defined in the <a href="../../../../../../../org/apache/logging/log4j/core/layout/log4j.dtd">log4j.dtd</a>.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final class </code></div> |
| <div class="col-second even-row-color"><code><a href="../YamlLayout.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">YamlLayout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Appends a series of YAML events as strings serialized as bytes.</div> |
| </div> |
| </div> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.layout</a> that return <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></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">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="../Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><<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>></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">AbstractStringLayout.</span><code><a href="../AbstractStringLayout.html#getStringBuilderEncoder()" class="member-name-link">getStringBuilderEncoder</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Returns a <code>Encoder<StringBuilder></code> that this Layout implementation can use for encoding log events.</div> |
| </div> |
| </div> |
| </section> |
| </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> |
