Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / org / apache / logging / log4j / core / layout / AbstractStringLayout.html
blob: 2815f08d337525d3e994e42a21fa1829549dbaf9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Feb 25 21:03:11 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractStringLayout (Apache Log4j Core 2.13.1 API)</title>
<meta name="date" content="2020-02-25">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractStringLayout (Apache Log4j Core 2.13.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/layout/AbstractStringLayout.html" target="_top">Frames</a></li>
<li><a href="AbstractStringLayout.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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="subNavList">
<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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.core.layout</div>
<h2 title="Class AbstractStringLayout" class="title">Class AbstractStringLayout</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractLayout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.logging.log4j.core.layout.AbstractStringLayout</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a>, <a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;, <a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&gt;, <a href="../../../../../../org/apache/logging/log4j/core/StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/GelfLayout.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/HtmlLayout.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/JsonLayout.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/SyslogLayout.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/YamlLayout.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.49">AbstractStringLayout</a>
extends <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;
implements <a href="../../../../../../org/apache/logging/log4j/core/StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></pre>
<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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a> extends <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout.Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="type parameter in AbstractStringLayout.Builder">B</a>&gt;&gt;</span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer2.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></span></code>
<div class="block">Variation of <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout"><code>AbstractStringLayout.Serializer</code></a> that avoids allocating temporary objects.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#DEFAULT_STRING_BUILDER_SIZE">DEFAULT_STRING_BUILDER_SIZE</a></span></code>
<div class="block">Default length for new StringBuilder instances: 1024 .</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#MAX_STRING_BUILDER_SIZE">MAX_STRING_BUILDER_SIZE</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractLayout">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#configuration">configuration</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#eventCount">eventCount</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#footer">footer</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#header">header</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#LOGGER">LOGGER</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.Layout">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#ELEMENT_TYPE">ELEMENT_TYPE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#AbstractStringLayout-java.nio.charset.Charset-">AbstractStringLayout</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#AbstractStringLayout-java.nio.charset.Charset-byte:A-byte:A-">AbstractStringLayout</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;aCharset,
byte[]&nbsp;header,
byte[]&nbsp;footer)</code>
<div class="block">Builds a new layout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#AbstractStringLayout-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-">AbstractStringLayout</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;aCharset,
<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;headerSerializer,
<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;footerSerializer)</code>
<div class="block">Builds a new layout.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getBytes-java.lang.String-">getBytes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;s)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getCharset--">getCharset</a></span>()</code>
<div class="block">Gets the Charset this layout uses to encode Strings into bytes.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getContentType--">getContentType</a></span>()</code>
<div class="block">Returns the content type output by this layout.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getFooter--">getFooter</a></span>()</code>
<div class="block">Returns the footer, if one is available.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getFooterSerializer--">getFooterSerializer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getHeader--">getHeader</a></span>()</code>
<div class="block">Returns the header, if one is available.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getHeaderSerializer--">getHeaderSerializer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getStringBuilder--">getStringBuilder</a></span>()</code>
<div class="block">Returns a <code>StringBuilder</code> that this Layout implementation can use to write the formatted log event to.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#getStringBuilderEncoder--">getStringBuilderEncoder</a></span>()</code>
<div class="block">Returns a <code>Encoder&lt;StringBuilder&gt;</code> that this Layout implementation can use for encoding log events.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#requiresLocation--">requiresLocation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#serializeToBytes-org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer-byte:A-">serializeToBytes</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;serializer,
byte[]&nbsp;defaultValue)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#serializeToString-org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer-">serializeToString</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;serializer)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#toByteArray-org.apache.logging.log4j.core.LogEvent-">toByteArray</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</code>
<div class="block">Formats the Log Event as a byte array.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html#trimToMaxSize-java.lang.StringBuilder-">trimToMaxSize</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;stringBuilder)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.layout.AbstractLayout">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#encode-org.apache.logging.log4j.core.LogEvent-org.apache.logging.log4j.core.layout.ByteBufferDestination-">encode</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#getConfiguration--">getConfiguration</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#getContentFormat--">getContentFormat</a>, <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#markEvent--">markEvent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.Layout">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.logging.log4j.core.<a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#getContentFormat--">getContentFormat</a>, <a href="../../../../../../org/apache/logging/log4j/core/Layout.html#toSerializable-org.apache.logging.log4j.core.LogEvent-">toSerializable</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.layout.Encoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.logging.log4j.core.layout.<a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html#encode-T-org.apache.logging.log4j.core.layout.ByteBufferDestination-">encode</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_STRING_BUILDER_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_STRING_BUILDER_SIZE</h4>
<pre>protected static final&nbsp;int <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.116">DEFAULT_STRING_BUILDER_SIZE</a></pre>
<div class="block">Default length for new StringBuilder instances: 1024 .</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.layout.AbstractStringLayout.DEFAULT_STRING_BUILDER_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MAX_STRING_BUILDER_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_STRING_BUILDER_SIZE</h4>
<pre>protected static final&nbsp;int <a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.118">MAX_STRING_BUILDER_SIZE</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractStringLayout-java.nio.charset.Charset-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractStringLayout</h4>
<pre>protected&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.171">AbstractStringLayout</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset)</pre>
</li>
</ul>
<a name="AbstractStringLayout-java.nio.charset.Charset-byte:A-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractStringLayout</h4>
<pre>protected&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.182">AbstractStringLayout</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;aCharset,
byte[]&nbsp;header,
byte[]&nbsp;footer)</pre>
<div class="block">Builds a new layout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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>
</li>
</ul>
<a name="AbstractStringLayout-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-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractStringLayout</h4>
<pre>protected&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.201">AbstractStringLayout</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;aCharset,
<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;headerSerializer,
<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;footerSerializer)</pre>
<div class="block">Builds a new layout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - the configuration</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>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="requiresLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiresLocation</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.91">requiresLocation</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/impl/LocationAware.html#requiresLocation--">requiresLocation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code></dd>
</dl>
</li>
</ul>
<a name="getStringBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringBuilder</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.128">getStringBuilder</a>()</pre>
<div class="block">Returns a <code>StringBuilder</code> that this Layout implementation can use to write the formatted log event to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>StringBuilder</code></dd>
</dl>
</li>
</ul>
<a name="trimToMaxSize-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimToMaxSize</h4>
<pre>protected static&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.152">trimToMaxSize</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;stringBuilder)</pre>
</li>
</ul>
<a name="getBytes-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>protected&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.213">getBytes</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;s)</pre>
</li>
</ul>
<a name="getCharset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharset</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.225">getCharset</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/StringLayout.html#getCharset--">StringLayout</a></code></span></div>
<div class="block">Gets the Charset this layout uses to encode Strings into bytes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/StringLayout.html#getCharset--">getCharset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Charset this layout uses to encode Strings into bytes.</dd>
</dl>
</li>
</ul>
<a name="getContentType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentType</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.233">getContentType</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#getContentType--">getContentType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The default content type for Strings.</dd>
</dl>
</li>
</ul>
<a name="getFooter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFooter</h4>
<pre>public&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.243">getFooter</a>()</pre>
<div class="block">Returns the footer, if one is available.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#getFooter--">getFooter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#getFooter--">getFooter</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A byte array containing the footer.</dd>
</dl>
</li>
</ul>
<a name="getFooterSerializer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFooterSerializer</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.247">getFooterSerializer</a>()</pre>
</li>
</ul>
<a name="getHeader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeader</h4>
<pre>public&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.257">getHeader</a>()</pre>
<div class="block">Returns the header, if one is available.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#getHeader--">getHeader</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html#getHeader--">getHeader</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A byte array containing the header.</dd>
</dl>
</li>
</ul>
<a name="getHeaderSerializer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaderSerializer</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.261">getHeaderSerializer</a>()</pre>
</li>
</ul>
<a name="getStringBuilderEncoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringBuilderEncoder</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.274">getStringBuilderEncoder</a>()</pre>
<div class="block">Returns a <code>Encoder&lt;StringBuilder&gt;</code> that this Layout implementation can use for encoding log events.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Encoder&lt;StringBuilder&gt;</code></dd>
</dl>
</li>
</ul>
<a name="serializeToBytes-org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeToBytes</h4>
<pre>protected&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.281">serializeToBytes</a>(<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;serializer,
byte[]&nbsp;defaultValue)</pre>
</li>
</ul>
<a name="serializeToString-org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeToString</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.289">serializeToString</a>(<a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>&nbsp;serializer)</pre>
</li>
</ul>
<a name="toByteArray-org.apache.logging.log4j.core.LogEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toByteArray</h4>
<pre>public&nbsp;byte[]&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/layout/AbstractStringLayout.html#line.307">toByteArray</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</pre>
<div class="block">Formats the Log Event as a byte array.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html#toByteArray-org.apache.logging.log4j.core.LogEvent-">toByteArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - The Log Event.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The formatted event as a byte array.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/layout/AbstractStringLayout.html" target="_top">Frames</a></li>
<li><a href="AbstractStringLayout.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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="subNavList">
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <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>
</body>
</html>