| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractStringLayout (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, class: AbstractStringLayout"> |
| <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/AbstractStringLayout.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.layout</a></div> |
| <h1 title="Class AbstractStringLayout" class="title">Class AbstractStringLayout</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"><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> |
| <div class="inheritance">org.apache.logging.log4j.core.layout.AbstractStringLayout</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code>, <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code>, <code><a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>></code>, <code><a href="../StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code>, <code><a href="GelfLayout.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout</a></code>, <code><a href="HtmlLayout.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout</a></code>, <code><a href="JsonLayout.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout</a></code>, <code><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></code>, <code><a href="Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></code>, <code><a href="SyslogLayout.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout</a></code>, <code><a href="XmlLayout.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout</a></code>, <code><a href="YamlLayout.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractStringLayout</span> |
| <span class="extends-implements">extends <a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> |
| implements <a href="../StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a>, <a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></span></div> |
| <div class="block">Abstract base class for Layouts that result in a String. |
| <p> |
| Since 2.4.1, this class has custom logic to convert ISO-8859-1 or US-ASCII Strings to byte[] arrays to improve |
| performance: all characters are simply cast to bytes. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</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>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="AbstractStringLayout.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><<a href="AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a> extends <a href="AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a><<a href="AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a>>></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="AbstractStringLayout.Serializer.html" class="type-name-link" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="AbstractStringLayout.Serializer2.html" class="type-name-link" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_STRING_BUILDER_SIZE" class="member-name-link">DEFAULT_STRING_BUILDER_SIZE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default length for new StringBuilder instances: 1024 .</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#MAX_STRING_BUILDER_SIZE" class="member-name-link">MAX_STRING_BUILDER_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractLayout">Fields inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="AbstractLayout.html#configuration">configuration</a>, <a href="AbstractLayout.html#eventCount">eventCount</a>, <a href="AbstractLayout.html#footer">footer</a>, <a href="AbstractLayout.html#header">header</a>, <a href="AbstractLayout.html#LOGGER">LOGGER</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Layout">Fields inherited from interface org.apache.logging.log4j.core.<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3> |
| <code><a href="../Layout.html#ELEMENT_TYPE">ELEMENT_TYPE</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.nio.charset.Charset)" class="member-name-link">AbstractStringLayout</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.nio.charset.Charset,byte%5B%5D,byte%5B%5D)" class="member-name-link">AbstractStringLayout</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> aCharset, |
| byte[] header, |
| byte[] footer)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Builds a new layout.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer,org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer)" class="member-name-link">AbstractStringLayout</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> aCharset, |
| <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> headerSerializer, |
| <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> footerSerializer)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Builds a new layout.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBytes(java.lang.String)" class="member-name-link">getBytes</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> s)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCharset()" class="member-name-link">getCharset</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 Charset this layout uses to encode Strings into bytes.</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="#getContentType()" class="member-name-link">getContentType</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 content type output by this layout.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFooter()" class="member-name-link">getFooter</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 footer, if one is available.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFooterSerializer()" class="member-name-link">getFooterSerializer</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeader()" class="member-name-link">getHeader</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 header, if one is available.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaderSerializer()" class="member-name-link">getHeaderSerializer</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStringBuilder()" class="member-name-link">getStringBuilder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a <code>StringBuilder</code> that this Layout implementation can use to write the formatted log event to.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStringBuilderEncoder()" class="member-name-link">getStringBuilderEncoder</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 a <code>Encoder<StringBuilder></code> that this Layout implementation can use for encoding log events.</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="#requiresLocation()" class="member-name-link">requiresLocation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeToBytes(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer,byte%5B%5D)" class="member-name-link">serializeToBytes</a><wbr>(<a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> serializer, |
| byte[] defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/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="#serializeToString(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer)" class="member-name-link">serializeToString</a><wbr>(<a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> serializer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toByteArray(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">toByteArray</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats the Log Event as a byte array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#trimToMaxSize(java.lang.StringBuilder)" class="member-name-link">trimToMaxSize</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> stringBuilder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractLayout">Methods inherited from class org.apache.logging.log4j.core.layout.<a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="AbstractLayout.html#encode(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a>, <a href="AbstractLayout.html#getConfiguration()">getConfiguration</a>, <a href="AbstractLayout.html#getContentFormat()">getContentFormat</a>, <a href="AbstractLayout.html#markEvent()">markEvent</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.Encoder">Methods inherited from interface org.apache.logging.log4j.core.layout.<a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></h3> |
| <code><a href="Encoder.html#encode(T,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.Layout">Methods inherited from interface org.apache.logging.log4j.core.<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3> |
| <code><a href="../Layout.html#getContentFormat()">getContentFormat</a>, <a href="../Layout.html#toSerializable(org.apache.logging.log4j.core.LogEvent)">toSerializable</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="DEFAULT_STRING_BUILDER_SIZE"> |
| <h3>DEFAULT_STRING_BUILDER_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_STRING_BUILDER_SIZE</span></div> |
| <div class="block">Default length for new StringBuilder instances: 1024 .</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.layout.AbstractStringLayout.DEFAULT_STRING_BUILDER_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MAX_STRING_BUILDER_SIZE"> |
| <h3>MAX_STRING_BUILDER_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">MAX_STRING_BUILDER_SIZE</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.nio.charset.Charset)"> |
| <h3>AbstractStringLayout</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractStringLayout</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.nio.charset.Charset,byte[],byte[])"> |
| <h3>AbstractStringLayout</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractStringLayout</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> aCharset, |
| byte[] header, |
| byte[] footer)</span></div> |
| <div class="block">Builds a new layout.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>aCharset</code> - the charset used to encode the header bytes, footer bytes and anything else that needs to be |
| converted from strings to bytes.</dd> |
| <dd><code>header</code> - the header bytes</dd> |
| <dd><code>footer</code> - the footer bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer,org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer)"> |
| <h3>AbstractStringLayout</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractStringLayout</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> aCharset, |
| <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> headerSerializer, |
| <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> footerSerializer)</span></div> |
| <div class="block">Builds a new layout.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - the configuration. May be null.</dd> |
| <dd><code>aCharset</code> - the charset used to encode the header bytes, footer bytes and anything else that needs to be |
| converted from strings to bytes.</dd> |
| <dd><code>headerSerializer</code> - the header bytes serializer</dd> |
| <dd><code>footerSerializer</code> - the footer bytes serializer</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="requiresLocation()"> |
| <h3>requiresLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">requiresLocation</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../impl/LocationAware.html#requiresLocation()">requiresLocation</a></code> in interface <code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStringBuilder()"> |
| <h3>getStringBuilder</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></span> <span class="element-name">getStringBuilder</span>()</div> |
| <div class="block">Returns a <code>StringBuilder</code> that this Layout implementation can use to write the formatted log event to.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <code>StringBuilder</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trimToMaxSize(java.lang.StringBuilder)"> |
| <h3>trimToMaxSize</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">void</span> <span class="element-name">trimToMaxSize</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> stringBuilder)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBytes(java.lang.String)"> |
| <h3>getBytes</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">byte[]</span> <span class="element-name">getBytes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCharset()"> |
| <h3>getCharset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span> <span class="element-name">getCharset</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../StringLayout.html#getCharset()">StringLayout</a></code></span></div> |
| <div class="block">Gets the Charset this layout uses to encode Strings into bytes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../StringLayout.html#getCharset()">getCharset</a></code> in interface <code><a href="../StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the Charset this layout uses to encode Strings into bytes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContentType()"> |
| <h3>getContentType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getContentType</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Layout.html#getContentType()">Layout</a></code></span></div> |
| <div class="block">Returns the content type output by this layout. The base class returns "text/plain".</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Layout.html#getContentType()">getContentType</a></code> in interface <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>The default content type for Strings.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFooter()"> |
| <h3>getFooter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">getFooter</span>()</div> |
| <div class="block">Returns the footer, if one is available.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Layout.html#getFooter()">getFooter</a></code> in interface <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractLayout.html#getFooter()">getFooter</a></code> in class <code><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>A byte array containing the footer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFooterSerializer()"> |
| <h3>getFooterSerializer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></span> <span class="element-name">getFooterSerializer</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeader()"> |
| <h3>getHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">getHeader</span>()</div> |
| <div class="block">Returns the header, if one is available.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Layout.html#getHeader()">getHeader</a></code> in interface <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractLayout.html#getHeader()">getHeader</a></code> in class <code><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>A byte array containing the header.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaderSerializer()"> |
| <h3>getHeaderSerializer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></span> <span class="element-name">getHeaderSerializer</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStringBuilderEncoder()"> |
| <h3>getStringBuilderEncoder</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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>></span> <span class="element-name">getStringBuilderEncoder</span>()</div> |
| <div class="block">Returns a <code>Encoder<StringBuilder></code> that this Layout implementation can use for encoding log events.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <code>Encoder<StringBuilder></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serializeToBytes(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer,byte[])"> |
| <h3>serializeToBytes</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">byte[]</span> <span class="element-name">serializeToBytes</span><wbr><span class="parameters">(<a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> serializer, |
| byte[] defaultValue)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serializeToString(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer)"> |
| <h3>serializeToString</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">serializeToString</span><wbr><span class="parameters">(<a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a> serializer)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toByteArray(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>toByteArray</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| <div class="block">Formats the Log Event as a byte array.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Layout.html#toByteArray(org.apache.logging.log4j.core.LogEvent)">toByteArray</a></code> in interface <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The Log Event.</dd> |
| <dt>Returns:</dt> |
| <dd>The formatted event as a byte array.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
