| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>PatternLayout (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: PatternLayout"> |
| <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/PatternLayout.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.layout</a></div> |
| <h1 title="Class PatternLayout" class="title">Class PatternLayout</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout.AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> |
| <div class="inheritance"><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.PatternLayout</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><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code>, <code><a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>></code>, <code><a href="../StringLayout.html" title="interface in org.apache.logging.log4j.core">StringLayout</a></code></dd> |
| </dl> |
| <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>="PatternLayout", |
| <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">PatternLayout</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">A flexible layout configurable with pattern string. |
| <p> |
| The goal of this class is to <a href="../Layout.html#toByteArray(org.apache.logging.log4j.core.LogEvent)"><code>format</code></a> a <a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core"><code>LogEvent</code></a> and |
| return the results. The format of the result depends on the <em>conversion pattern</em>. |
| </p> |
| <p> |
| The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern |
| is composed of literal text and format control expressions called <em>conversion specifiers</em>. |
| </p> |
| <p> |
| See the Log4j Manual for details on the supported pattern converters. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="PatternLayout.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Custom PatternLayout builder.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="PatternLayout.SerializerBuilder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.layout">PatternLayout.SerializerBuilder</a></code></div> |
| <div class="col-last odd-row-color"> </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 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>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_CONVERSION_PATTERN" class="member-name-link">DEFAULT_CONVERSION_PATTERN</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default pattern string for log output.</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color"><code><a href="#KEY" class="member-name-link">KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Key to identify pattern converters.</div> |
| </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="#SIMPLE_CONVERSION_PATTERN" class="member-name-link">SIMPLE_CONVERSION_PATTERN</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A simple pattern.</div> |
| </div> |
| <div class="col-first odd-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 odd-row-color"><code><a href="#TTCC_CONVERSION_PATTERN" class="member-name-link">TTCC_CONVERSION_PATTERN</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">A conversion pattern equivalent to the TTCCLayout.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.layout.AbstractStringLayout">Fields inherited from class 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 org.apache.logging.log4j.core.layout.<a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a></h3> |
| <code><a href="AbstractLayout.html#configuration">configuration</a>, <a href="AbstractLayout.html#eventCount">eventCount</a>, <a href="AbstractLayout.html#footer">footer</a>, <a href="AbstractLayout.html#header">header</a>, <a href="AbstractLayout.html#LOGGER">LOGGER</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Layout">Fields inherited from interface org.apache.logging.log4j.core.<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a></h3> |
| <code><a href="../Layout.html#ELEMENT_TYPE">ELEMENT_TYPE</a></code></div> |
| </section> |
| </li> |
| <!-- ========== 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 <a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></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 PatternLayout using the default options.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createDefaultLayout(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">createDefaultLayout</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a PatternLayout using the default options and the given configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createLayout(java.lang.String,org.apache.logging.log4j.core.layout.PatternSelector,org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.pattern.RegexReplacement,java.nio.charset.Charset,boolean,boolean,java.lang.String,java.lang.String)" class="member-name-link">createLayout</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> pattern, |
| <a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a> patternSelector, |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="../pattern/RegexReplacement.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacement</a> replace, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| boolean alwaysWriteExceptions, |
| boolean noConsoleNoAnsi, |
| <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> 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> footerPattern)</code></div> |
| <div class="col-last even-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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../pattern/PatternParser.html" title="class in org.apache.logging.log4j.core.pattern">PatternParser</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createPatternParser(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">createPatternParser</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a PatternParser.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createSerializer(org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.pattern.RegexReplacement,java.lang.String,java.lang.String,org.apache.logging.log4j.core.layout.PatternSelector,boolean,boolean)" class="member-name-link">createSerializer</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration, |
| <a href="../pattern/RegexReplacement.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacement</a> replace, |
| <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> pattern, |
| <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> defaultPattern, |
| <a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a> patternSelector, |
| boolean alwaysWriteExceptions, |
| boolean noConsoleNoAnsi)</code></div> |
| <div class="col-last even-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="#newSerializerBuilder()"><code>newSerializerBuilder()</code></a> instead.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#encode(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.layout.ByteBufferDestination)" class="member-name-link">encode</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout">ByteBufferDestination</a> destination)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Encodes the specified source LogEvent to some binary representation and writes the result to the specified |
| destination.</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><<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>></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">Gets this PatternLayout's 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="#getConversionPattern()" class="member-name-link">getConversionPattern</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the conversion pattern.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEventSerializer()" class="member-name-link">getEventSerializer</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div> |
| <div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a builder for a custom PatternLayout.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="PatternLayout.SerializerBuilder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.SerializerBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newSerializerBuilder()" class="member-name-link">newSerializerBuilder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requiresLocation()" class="member-name-link">requiresLocation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serialize(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)" class="member-name-link">serialize</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> stringBuilder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/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> 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 logging event to a writer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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 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#getContentType()">getContentType</a>, <a href="AbstractStringLayout.html#getFooter()">getFooter</a>, <a href="AbstractStringLayout.html#getFooterSerializer()">getFooterSerializer</a>, <a href="AbstractStringLayout.html#getHeader()">getHeader</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#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 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#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 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#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> |
| </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_CONVERSION_PATTERN"> |
| <h3>DEFAULT_CONVERSION_PATTERN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">DEFAULT_CONVERSION_PATTERN</span></div> |
| <div class="block">Default pattern string for log output. Currently set to the string <b>"%m%n"</b> which just prints the |
| application supplied message.</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.PatternLayout.DEFAULT_CONVERSION_PATTERN">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TTCC_CONVERSION_PATTERN"> |
| <h3>TTCC_CONVERSION_PATTERN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">TTCC_CONVERSION_PATTERN</span></div> |
| <div class="block">A conversion pattern equivalent to the TTCCLayout. Current value is <b>%r [%t] %p %c %notEmpty{%x }- %m%n</b>.</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.PatternLayout.TTCC_CONVERSION_PATTERN">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SIMPLE_CONVERSION_PATTERN"> |
| <h3>SIMPLE_CONVERSION_PATTERN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">SIMPLE_CONVERSION_PATTERN</span></div> |
| <div class="block">A simple pattern. Current value is <b>%d [%t] %p %c - %m%n</b>.</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.PatternLayout.SIMPLE_CONVERSION_PATTERN">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="KEY"> |
| <h3>KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">KEY</span></div> |
| <div class="block">Key to identify pattern converters.</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.PatternLayout.KEY">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="newSerializerBuilder()"> |
| <h3>newSerializerBuilder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="PatternLayout.SerializerBuilder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.SerializerBuilder</a></span> <span class="element-name">newSerializerBuilder</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="requiresLocation()"> |
| <h3>requiresLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">requiresLocation</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../impl/LocationAware.html#requiresLocation()">requiresLocation</a></code> in interface <code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractStringLayout.html#requiresLocation()">requiresLocation</a></code> in class <code><a href="AbstractStringLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractStringLayout</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSerializer(org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.pattern.RegexReplacement,java.lang.String,java.lang.String,org.apache.logging.log4j.core.layout.PatternSelector,boolean,boolean)"> |
| <h3>createSerializer</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> <span class="return-type"><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></span> <span class="element-name">createSerializer</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration, |
| <a href="../pattern/RegexReplacement.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacement</a> replace, |
| <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> pattern, |
| <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> defaultPattern, |
| <a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a> patternSelector, |
| boolean alwaysWriteExceptions, |
| boolean noConsoleNoAnsi)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#newSerializerBuilder()"><code>newSerializerBuilder()</code></a> instead.</div> |
| </div> |
| <div class="block">Deprecated, use <a href="#newSerializerBuilder()"><code>newSerializerBuilder()</code></a> instead.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configuration</code> - the current configuration</dd> |
| <dd><code>replace</code> - Allows portions of the resulting String to be replaced.</dd> |
| <dd><code>pattern</code> - the current pattern</dd> |
| <dd><code>defaultPattern</code> - the default pattern</dd> |
| <dd><code>patternSelector</code> - Allows different patterns to be used with the PatternLayout based on some selection criteria.</dd> |
| <dd><code>alwaysWriteExceptions</code> - To always write exceptions even if the pattern contains no exception conversions.</dd> |
| <dd><code>noConsoleNoAnsi</code> - Do not output ANSI escape codes if System.console() is null.</dd> |
| <dt>Returns:</dt> |
| <dd>a new Serializer</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConversionPattern()"> |
| <h3>getConversionPattern</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getConversionPattern</span>()</div> |
| <div class="block">Gets the conversion pattern.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the conversion pattern.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContentFormat()"> |
| <h3>getContentFormat</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<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>></span> <span class="element-name">getContentFormat</span>()</div> |
| <div class="block">Gets this PatternLayout's content format. Specified by: |
| <ul> |
| <li>Key: "structured" Value: "false"</li> |
| <li>Key: "formatType" Value: "conversion" (format uses the keywords supported by OptionConverter)</li> |
| <li>Key: "format" Value: provided "conversionPattern" param</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Layout.html#getContentFormat()">getContentFormat</a></code> in interface <code><a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractLayout.html#getContentFormat()">getContentFormat</a></code> in class <code><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>Map of content format keys supporting PatternLayout</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="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toSerializable</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| <div class="block">Formats a logging event to a writer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - logging event to be formatted.</dd> |
| <dt>Returns:</dt> |
| <dd>The event formatted as a String.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serialize(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)"> |
| <h3>serialize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">serialize</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> stringBuilder)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="encode(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.layout.ByteBufferDestination)"> |
| <h3>encode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">encode</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="ByteBufferDestination.html" title="interface in org.apache.logging.log4j.core.layout">ByteBufferDestination</a> destination)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractLayout.html#encode(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.layout.ByteBufferDestination)">AbstractLayout</a></code></span></div> |
| <div class="block">Encodes the specified source LogEvent to some binary representation and writes the result to the specified |
| destination. |
| <p> |
| The default implementation of this method delegates to the <a href="../Layout.html#toByteArray(org.apache.logging.log4j.core.LogEvent)"><code>Layout.toByteArray(LogEvent)</code></a> method which allocates |
| temporary objects. |
| </p><p> |
| Subclasses can override this method to provide a garbage-free implementation. For text-based layouts, |
| <code>AbstractStringLayout</code> provides various convenience methods to help with this: |
| </p> |
| <pre> @Plugin(name = "MyLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true) |
| public final class MyLayout extends AbstractStringLayout { |
| @Override |
| public void encode(LogEvent event, ByteBufferDestination destination) { |
| StringBuilder text = getStringBuilder(); |
| convertLogEventToText(event, text); |
| getStringBuilderEncoder().encode(text, destination); |
| } |
| |
| private void convertLogEventToText(LogEvent event, StringBuilder destination) { |
| ... // append a text representation of the log event to the StringBuilder |
| } |
| } |
| </pre></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Encoder.html#encode(T,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a></code> in interface <code><a href="Encoder.html" title="interface in org.apache.logging.log4j.core.layout">Encoder</a><<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractLayout.html#encode(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.layout.ByteBufferDestination)">encode</a></code> in class <code><a href="AbstractLayout.html" title="class in org.apache.logging.log4j.core.layout">AbstractLayout</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the LogEvent to encode.</dd> |
| <dd><code>destination</code> - holds the ByteBuffer to write into.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="AbstractStringLayout.html#getStringBuilder()"><code>AbstractStringLayout.getStringBuilder()</code></a></li> |
| <li><a href="AbstractStringLayout.html#getStringBuilderEncoder()"><code>AbstractStringLayout.getStringBuilderEncoder()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createPatternParser(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>createPatternParser</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../pattern/PatternParser.html" title="class in org.apache.logging.log4j.core.pattern">PatternParser</a></span> <span class="element-name">createPatternParser</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</span></div> |
| <div class="block">Creates a PatternParser.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>config</code> - The Configuration or <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>The PatternParser.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLayout(java.lang.String,org.apache.logging.log4j.core.layout.PatternSelector,org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.pattern.RegexReplacement,java.nio.charset.Charset,boolean,boolean,java.lang.String,java.lang.String)"> |
| <h3>createLayout</h3> |
| <div class="member-signature"><span class="annotations"><a href="../config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginFactory</a> |
| <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> <span class="return-type"><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></span> <span class="element-name">createLayout</span><wbr><span class="parameters">(<a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../config/plugins/PluginAttribute.html#value()">value</a>="pattern",<a href="../config/plugins/PluginAttribute.html#defaultString()">defaultString</a>="%m%n") |
| <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> pattern, |
| <a href="../config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("PatternSelector") |
| <a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a> patternSelector, |
| <a href="../config/plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="../config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("Replace") |
| <a href="../pattern/RegexReplacement.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacement</a> replace, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("charset") |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a> charset, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="../config/plugins/PluginAttribute.html#value()">value</a>="alwaysWriteExceptions",<a href="../config/plugins/PluginAttribute.html#defaultBoolean()">defaultBoolean</a>=true) |
| boolean alwaysWriteExceptions, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("noConsoleNoAnsi") |
| boolean noConsoleNoAnsi, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("header") |
| <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> headerPattern, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("footer") |
| <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> footerPattern)</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. This will be private in a future version.</div> |
| </div> |
| <div class="block">Creates a pattern layout.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.</dd> |
| <dd><code>patternSelector</code> - Allows different patterns to be used based on some selection criteria.</dd> |
| <dd><code>config</code> - The Configuration. Some Converters require access to the Interpolator.</dd> |
| <dd><code>replace</code> - A Regex replacement String.</dd> |
| <dd><code>charset</code> - The character set. The platform default is used if not specified.</dd> |
| <dd><code>alwaysWriteExceptions</code> - If <code>"true"</code> (default) exceptions are always written even if the pattern contains no exception tokens.</dd> |
| <dd><code>noConsoleNoAnsi</code> - If <code>"true"</code> (default is false) and <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#console--" title="class or interface in java.lang" class="external-link"><code>System.console()</code></a> is null, do not output ANSI escape codes</dd> |
| <dd><code>headerPattern</code> - The footer to place at the top of the document, once.</dd> |
| <dd><code>footerPattern</code> - The footer to place at the bottom of the document, once.</dd> |
| <dt>Returns:</dt> |
| <dd>The PatternLayout.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createDefaultLayout()"> |
| <h3>createDefaultLayout</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></span> <span class="element-name">createDefaultLayout</span>()</div> |
| <div class="block">Creates a PatternLayout using the default options. These options include using UTF-8, the default conversion |
| pattern, exceptions being written, and with ANSI escape codes.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the PatternLayout.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#DEFAULT_CONVERSION_PATTERN"><code>Default conversion pattern</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createDefaultLayout(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>createDefaultLayout</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></span> <span class="element-name">createDefaultLayout</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| <div class="block">Creates a PatternLayout using the default options and the given configuration. These options include using UTF-8, |
| the default conversion pattern, exceptions being written, and with ANSI escape codes.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configuration</code> - The Configuration.</dd> |
| <dt>Returns:</dt> |
| <dd>the PatternLayout.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#DEFAULT_CONVERSION_PATTERN"><code>Default conversion pattern</code></a></li> |
| </ul> |
| </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> <span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span> <span class="element-name">newBuilder</span>()</div> |
| <div class="block">Creates a builder for a custom PatternLayout.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a PatternLayout builder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEventSerializer()"> |
| <h3>getEventSerializer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AbstractStringLayout.Serializer.html" title="interface in org.apache.logging.log4j.core.layout">AbstractStringLayout.Serializer</a></span> <span class="element-name">getEventSerializer</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
