blob: 8f9c0dd7dab5a234767482b9cf0de278d7bb5aad [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>YamlLayout (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: YamlLayout">
<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/YamlLayout.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><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="sub-nav-list">
<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>
<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.layout</a></div>
<h1 title="Class YamlLayout" class="title">Class YamlLayout</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>&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>&gt;
<div class="inheritance"><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractStringLayout</a>
<div class="inheritance">org.apache.logging.log4j.core.layout.YamlLayout</div>
</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>&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>&gt;</code>, <code><a href="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>, <code><a href="../StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations"><a href="../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../config/plugins/Plugin.html#name()">name</a>="YamlLayout",
<a href="../config/plugins/Plugin.html#category()">category</a>="Core",
<a href="../config/plugins/Plugin.html#elementType()">elementType</a>="layout",
<a href="../config/plugins/Plugin.html#printObject()">printObject</a>=true)
</span><span class="modifiers">public final class </span><span class="element-name type-name-label">YamlLayout</span>
<span class="extends-implements">extends <a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></span></div>
<div class="block">Appends a series of YAML events as strings serialized as bytes.
<h2>Encoding</h2>
<p>
Appenders using this layout should have their <code>charset</code> set to <code>UTF-8</code> or <code>UTF-16</code>, otherwise
events containing non ASCII characters could result in corrupted log files.
</p>
<h2>Additional Fields</h2>
<p>
This property allows addition of custom fields into generated JSON.
<code>&lt;YamlLayout&gt;&lt;KeyValuePair key="foo" value="bar"/&gt;&lt;/YamlLayout&gt;</code> inserts <code>foo: "bar"</code> directly
into YAML output. Supports Lookup expressions.
</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&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="YamlLayout.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a>&lt;<a href="YamlLayout.Builder.html" title="type parameter in YamlLayout.Builder">B</a> extends <a href="YamlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a>&lt;<a href="YamlLayout.Builder.html" title="type parameter in YamlLayout.Builder">B</a>&gt;&gt;</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Nested classes/interfaces inherited from class&nbsp;org.apache.logging.log4j.core.layout.<a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h2>
<code><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a>, <a href="AbstractStringLayout.Serializer2.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer2</a></code></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 final org.apache.logging.log4j.core.layout.AbstractJacksonLayout.ResolvableKeyValuePair[]</code></div>
<div class="col-second even-row-color"><code><a href="#additionalFields" class="member-name-link">additionalFields</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#compact" class="member-name-link">compact</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected 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="#COMPACT_EOL" class="member-name-link">COMPACT_EOL</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#complete" class="member-name-link">complete</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected 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="#DEFAULT_EOL" class="member-name-link">DEFAULT_EOL</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected 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 odd-row-color"><code><a href="#eol" class="member-name-link">eol</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#includeNullDelimiter" class="member-name-link">includeNullDelimiter</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final com.fasterxml.jackson.databind.ObjectWriter</code></div>
<div class="col-second odd-row-color"><code><a href="#objectWriter" class="member-name-link">objectWriter</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Fields inherited from class&nbsp;org.apache.logging.log4j.core.layout.<a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3>
<code><a href="AbstractStringLayout.html#DEFAULT_STRING_BUILDER_SIZE">DEFAULT_STRING_BUILDER_SIZE</a>, <a href="AbstractStringLayout.html#MAX_STRING_BUILDER_SIZE">MAX_STRING_BUILDER_SIZE</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractLayout">Fields inherited from class&nbsp;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&nbsp;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(org.apache.logging.log4j.core.config.Configuration,boolean,boolean,boolean,boolean,boolean,java.lang.String,java.lang.String,java.nio.charset.Charset,boolean)" class="member-name-link">YamlLayout</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config,
boolean&nbsp;locationInfo,
boolean&nbsp;properties,
boolean&nbsp;complete,
boolean&nbsp;compact,
boolean&nbsp;eventEol,
<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>&nbsp;headerPattern,
<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>&nbsp;footerPattern,
<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>&nbsp;charset,
boolean&nbsp;includeStacktrace)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#newBuilder()"><code>newBuilder()</code></a> instead</div>
</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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab1 method-summary-table-tab4"><code>static org.apache.logging.log4j.core.layout.AbstractJacksonLayout</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createDefaultLayout()" class="member-name-link">createDefaultLayout</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Creates a YAML Layout using the default settings.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static org.apache.logging.log4j.core.layout.AbstractJacksonLayout</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createLayout(org.apache.logging.log4j.core.config.Configuration,boolean,boolean,java.lang.String,java.lang.String,java.nio.charset.Charset,boolean)" class="member-name-link">createLayout</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config,
boolean&nbsp;locationInfo,
boolean&nbsp;properties,
<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>&nbsp;headerPattern,
<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>&nbsp;footerPattern,
<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>&nbsp;charset,
boolean&nbsp;includeStacktrace)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#newBuilder()"><code>newBuilder()</code></a> instead</div>
</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/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-tab4"><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-tab4">
<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-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 odd-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 odd-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 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="#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-tab4">
<div class="block">Returns appropriate YAML footer.</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="#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 appropriate YAML header.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static &lt;B extends <a href="YamlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a>&lt;B&gt;&gt;<br>B</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</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/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="#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-tab4">
<div class="block">Formats a <a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSerializable(org.apache.logging.log4j.core.LogEvent,java.io.Writer)" class="member-name-link">toSerializable</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html" title="class or interface in java.io" class="external-link">Writer</a>&nbsp;writer)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueNeedsLookup(java.lang.String)" class="member-name-link">valueNeedsLookup</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>&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#wrapLogEvent(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">wrapLogEvent</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-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Methods inherited from class&nbsp;org.apache.logging.log4j.core.layout.<a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></h3>
<code><a href="AbstractStringLayout.html#getBytes(java.lang.String)">getBytes</a>, <a href="AbstractStringLayout.html#getCharset()">getCharset</a>, <a href="AbstractStringLayout.html#getFooterSerializer()">getFooterSerializer</a>, <a href="AbstractStringLayout.html#getHeaderSerializer()">getHeaderSerializer</a>, <a href="AbstractStringLayout.html#getStringBuilder()">getStringBuilder</a>, <a href="AbstractStringLayout.html#getStringBuilderEncoder()">getStringBuilderEncoder</a>, <a href="AbstractStringLayout.html#requiresLocation()">requiresLocation</a>, <a href="AbstractStringLayout.html#serializeToBytes(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer,byte%5B%5D)">serializeToBytes</a>, <a href="AbstractStringLayout.html#serializeToString(org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer)">serializeToString</a>, <a href="AbstractStringLayout.html#toByteArray(org.apache.logging.log4j.core.LogEvent)">toByteArray</a>, <a href="AbstractStringLayout.html#trimToMaxSize(java.lang.StringBuilder)">trimToMaxSize</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractLayout">Methods inherited from class&nbsp;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#markEvent()">markEvent</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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&nbsp;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>
</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_EOL">
<h3>DEFAULT_EOL</h3>
<div class="member-signature"><span class="modifiers">protected 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">DEFAULT_EOL</span></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.YamlLayout.DEFAULT_EOL">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="COMPACT_EOL">
<h3>COMPACT_EOL</h3>
<div class="member-signature"><span class="modifiers">protected 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">COMPACT_EOL</span></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.YamlLayout.COMPACT_EOL">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="eol">
<h3>eol</h3>
<div class="member-signature"><span class="modifiers">protected 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">eol</span></div>
</section>
</li>
<li>
<section class="detail" id="objectWriter">
<h3>objectWriter</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">com.fasterxml.jackson.databind.ObjectWriter</span>&nbsp;<span class="element-name">objectWriter</span></div>
</section>
</li>
<li>
<section class="detail" id="compact">
<h3>compact</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">compact</span></div>
</section>
</li>
<li>
<section class="detail" id="complete">
<h3>complete</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">complete</span></div>
</section>
</li>
<li>
<section class="detail" id="includeNullDelimiter">
<h3>includeNullDelimiter</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">includeNullDelimiter</span></div>
</section>
</li>
<li>
<section class="detail" id="additionalFields">
<h3>additionalFields</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">org.apache.logging.log4j.core.layout.AbstractJacksonLayout.ResolvableKeyValuePair[]</span>&nbsp;<span class="element-name">additionalFields</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="&lt;init&gt;(org.apache.logging.log4j.core.config.Configuration,boolean,boolean,boolean,boolean,boolean,java.lang.String,java.lang.String,java.nio.charset.Charset,boolean)">
<h3>YamlLayout</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">protected</span>&nbsp;<span class="element-name">YamlLayout</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config,
boolean&nbsp;locationInfo,
boolean&nbsp;properties,
boolean&nbsp;complete,
boolean&nbsp;compact,
boolean&nbsp;eventEol,
<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>&nbsp;headerPattern,
<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>&nbsp;footerPattern,
<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>&nbsp;charset,
boolean&nbsp;includeStacktrace)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#newBuilder()"><code>newBuilder()</code></a> instead</div>
</div>
</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="getHeader()">
<h3>getHeader</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">getHeader</span>()</div>
<div class="block">Returns appropriate YAML header.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Layout.html#getHeader()">getHeader</a></code>&nbsp;in interface&nbsp;<code><a href="../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" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="AbstractStringLayout.html#getHeader()">getHeader</a></code>&nbsp;in class&nbsp;<code><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code></dd>
<dt>Returns:</dt>
<dd>a byte array containing the header, opening the YAML array.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFooter()">
<h3>getFooter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">getFooter</span>()</div>
<div class="block">Returns appropriate YAML footer.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Layout.html#getFooter()">getFooter</a></code>&nbsp;in interface&nbsp;<code><a href="../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" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="AbstractStringLayout.html#getFooter()">getFooter</a></code>&nbsp;in class&nbsp;<code><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code></dd>
<dt>Returns:</dt>
<dd>a byte array containing the footer, closing the YAML array.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContentFormat()">
<h3>getContentFormat</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Layout.html#getContentFormat()">Layout</a></code></span></div>
<div class="block">Returns a description of the content format.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Layout.html#getContentFormat()">getContentFormat</a></code>&nbsp;in interface&nbsp;<code><a href="../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" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="AbstractLayout.html#getContentFormat()">getContentFormat</a></code>&nbsp;in class&nbsp;<code><a href="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" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<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>
<li>
<section class="detail" id="getContentType()">
<h3>getContentType</h3>
<div class="member-signature"><span class="modifiers">public</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">getContentType</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<code><a href="../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" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="AbstractStringLayout.html#getContentType()">getContentType</a></code>&nbsp;in class&nbsp;<code><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code></dd>
<dt>Returns:</dt>
<dd>The content type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createLayout(org.apache.logging.log4j.core.config.Configuration,boolean,boolean,java.lang.String,java.lang.String,java.nio.charset.Charset,boolean)">
<h3>createLayout</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="return-type">org.apache.logging.log4j.core.layout.AbstractJacksonLayout</span>&nbsp;<span class="element-name">createLayout</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config,
boolean&nbsp;locationInfo,
boolean&nbsp;properties,
<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>&nbsp;headerPattern,
<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>&nbsp;footerPattern,
<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>&nbsp;charset,
boolean&nbsp;includeStacktrace)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="#newBuilder()"><code>newBuilder()</code></a> instead</div>
</div>
<div class="block">Creates a YAML Layout.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - The plugin configuration.</dd>
<dd><code>locationInfo</code> - If "true", includes the location information in the generated YAML.</dd>
<dd><code>properties</code> - If "true", includes the thread context map in the generated YAML.</dd>
<dd><code>headerPattern</code> - The header pattern, defaults to <code>""</code> if null.</dd>
<dd><code>footerPattern</code> - The footer pattern, defaults to <code>""</code> if null.</dd>
<dd><code>charset</code> - The character set to use, if <code>null</code>, uses "UTF-8".</dd>
<dd><code>includeStacktrace</code> - If "true", includes the stacktrace of any Throwable in the generated YAML, defaults to "true".</dd>
<dt>Returns:</dt>
<dd>A YAML Layout.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="newBuilder()">
<h3>newBuilder</h3>
<div class="member-signature"><span class="annotations"><a href="../config/plugins/PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginBuilderFactory</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="type-parameters">&lt;B extends <a href="YamlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a>&lt;B&gt;&gt;</span>&nbsp;<span class="return-type">B</span>&nbsp;<span class="element-name">newBuilder</span>()</div>
</section>
</li>
<li>
<section class="detail" id="createDefaultLayout()">
<h3>createDefaultLayout</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">org.apache.logging.log4j.core.layout.AbstractJacksonLayout</span>&nbsp;<span class="element-name">createDefaultLayout</span>()</div>
<div class="block">Creates a YAML Layout using the default settings. Useful for testing.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A YAML Layout.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="valueNeedsLookup(java.lang.String)">
<h3>valueNeedsLookup</h3>
<div class="member-signature"><span class="modifiers">protected static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">valueNeedsLookup</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>&nbsp;value)</span></div>
</section>
</li>
<li>
<section class="detail" id="toSerializable(org.apache.logging.log4j.core.LogEvent)">
<h3>toSerializable</h3>
<div class="member-signature"><span class="modifiers">public</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">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 a <a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>event</code> - The LogEvent.</dd>
<dt>Returns:</dt>
<dd>The XML representation of the LogEvent.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="wrapLogEvent(org.apache.logging.log4j.core.LogEvent)">
<h3>wrapLogEvent</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">wrapLogEvent</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>&nbsp;event)</span></div>
</section>
</li>
<li>
<section class="detail" id="toSerializable(org.apache.logging.log4j.core.LogEvent,java.io.Writer)">
<h3>toSerializable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</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,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html" title="class or interface in java.io" class="external-link">Writer</a>&nbsp;writer)</span>
throws <span class="exceptions">com.fasterxml.jackson.core.JsonGenerationException,
com.fasterxml.jackson.databind.JsonMappingException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code>com.fasterxml.jackson.core.JsonGenerationException</code></dd>
<dd><code>com.fasterxml.jackson.databind.JsonMappingException</code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></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>