Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-core / org / apache / logging / log4j / core / Layout.html
blob: 8757141b5eb2f918f0190415a6fd31231ad45b5f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Layout (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.logging.log4j.core, interface: Layout">
<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/Layout.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core</a></div>
<h1 title="Interface Layout" class="title">Interface Layout&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link"><code>Serializable</code></a> type returned by <a href="#toSerializable(org.apache.logging.log4j.core.LogEvent)"><code>toSerializable(LogEvent)</code></a></dd>
</dl>
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a>&lt;<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&gt;</code></dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="layout/AbstractCsvLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractCsvLayout</a></code>, <code><a href="layout/AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></code>, <code><a href="layout/AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code>, <code><a href="layout/CsvLogEventLayout.html" title="class in org.apache.logging.log4j.core.layout">CsvLogEventLayout</a></code>, <code><a href="layout/CsvParameterLayout.html" title="class in org.apache.logging.log4j.core.layout">CsvParameterLayout</a></code>, <code><a href="layout/GelfLayout.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout</a></code>, <code><a href="layout/HtmlLayout.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout</a></code>, <code><a href="layout/JsonLayout.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout</a></code>, <code><a href="layout/MessageLayout.html" title="class in org.apache.logging.log4j.core.layout">MessageLayout</a></code>, <code><a href="layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></code>, <code><a href="layout/Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></code>, <code><a href="layout/SerializedLayout.html" title="class in org.apache.logging.log4j.core.layout">SerializedLayout</a></code>, <code><a href="layout/SyslogLayout.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout</a></code>, <code><a href="layout/XmlLayout.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout</a></code>, <code><a href="layout/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 interface </span><span class="element-name type-name-label">Layout&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>&gt;</span><span class="extends-implements">
extends <a href="layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a>&lt;<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&gt;</span></div>
<div class="block">Lays out a <a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> in different formats.
The formats are:
<ul>
<li>
<code>byte[]</code></li>
<li>
an implementer of <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>, like <code>byte[]</code></li>
<li>
<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></li>
<li>
<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a></li>
</ul>
<p>
Since 2.6, Layouts can <a href="layout/Encoder.html#encode(T,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a> a <code>LogEvent</code> directly
to a <a href="layout/ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout"><code>ByteBufferDestination</code></a> without creating temporary intermediary objects.
</p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <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"><code><a href="#ELEMENT_TYPE" class="member-name-link">ELEMENT_TYPE</a></code></div>
<div class="col-last even-row-color">
<div class="block">Main <a href="config/plugins/Plugin.html#elementType()">plugin element type</a> for
Layout plugins.</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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContentFormat()" class="member-name-link">getContentFormat</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a description of the content format.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContentType()" class="member-name-link">getContentType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the content type output by this layout.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFooter()" class="member-name-link">getFooter</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the format for the layout format.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3">
<div class="block">Returns the header for the layout format.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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>&nbsp;event)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Formats the event suitable for display.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Layout.html" title="type parameter in Layout">T</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toSerializable(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">toSerializable</a><wbr>(<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Formats the event as an Object that can be serialized.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.Encoder">Methods inherited from interface&nbsp;org.apache.logging.log4j.core.layout.<a href="layout/Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a></h3>
<code><a href="layout/Encoder.html#encode(T,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</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="ELEMENT_TYPE">
<h3>ELEMENT_TYPE</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">ELEMENT_TYPE</span></div>
<div class="block">Main <a href="config/plugins/Plugin.html#elementType()">plugin element type</a> for
Layout plugins.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2.1</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.logging.log4j.core.Layout.ELEMENT_TYPE">Constant Field Values</a></li>
</ul>
</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="getFooter()">
<h3>getFooter</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name">getFooter</span>()</div>
<div class="block">Returns the format for the layout format.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The footer.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHeader()">
<h3>getHeader</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name">getHeader</span>()</div>
<div class="block">Returns the header for the layout format.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The header.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toByteArray(org.apache.logging.log4j.core.LogEvent)">
<h3>toByteArray</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name">toByteArray</span><wbr><span class="parameters">(<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</span></div>
<div class="block">Formats the event suitable for display.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>event</code> - The Logging Event.</dd>
<dt>Returns:</dt>
<dd>The formatted event.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toSerializable(org.apache.logging.log4j.core.LogEvent)">
<h3>toSerializable</h3>
<div class="member-signature"><span class="return-type"><a href="Layout.html" title="type parameter in Layout">T</a></span>&nbsp;<span class="element-name">toSerializable</span><wbr><span class="parameters">(<a href="LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</span></div>
<div class="block">Formats the event as an Object that can be serialized.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>event</code> - The Logging Event.</dd>
<dt>Returns:</dt>
<dd>The formatted event.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContentType()">
<h3>getContentType</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getContentType</span>()</div>
<div class="block">Returns the content type output by this layout. The base class returns "text/plain".</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the content type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContentFormat()">
<h3>getContentFormat</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getContentFormat</span>()</div>
<div class="block">Returns a description of the content format.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a Map of key/value pairs describing the Layout-specific content format, or an empty Map if no content
format descriptors are specified.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>