2.x/javadoc/log4j-core/org/apache/logging/log4j/core/layout/PatternLayout.Builder.html - logging-log4j-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>PatternLayout.Builder (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, class: Builder">
 <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.Builder.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.layout</a></div>
 <h1 title="Class PatternLayout.Builder" class="title">Class PatternLayout.Builder</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">org.apache.logging.log4j.core.layout.PatternLayout.Builder</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a>&lt;<a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a>&gt;</code></dd>
 </dl>
 <dl class="notes">
 <dt>Enclosing class:</dt>
 <dd><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">PatternLayout.Builder</span>
 <span class="extends-implements">extends <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>
 implements <a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a>&lt;<a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a>&gt;</span></div>
 <div class="block">Custom PatternLayout builder. Use the <a href="PatternLayout.html#newBuilder()"><code>builder factory method</code></a> to create this.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Builds the object after all configuration has been set.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#withAlwaysWriteExceptions(boolean)" class="member-name-link">withAlwaysWriteExceptions</a><wbr>(boolean&nbsp;alwaysWriteExceptions)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 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><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withCharset(java.nio.charset.Charset)" class="member-name-link">withCharset</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset)</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-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#withConfiguration(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">withConfiguration</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 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><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withDisableAnsi(boolean)" class="member-name-link">withDisableAnsi</a><wbr>(boolean&nbsp;disableAnsi)</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-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#withFooter(java.lang.String)" class="member-name-link">withFooter</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;footer)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 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><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withHeader(java.lang.String)" class="member-name-link">withHeader</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;header)</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-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#withNoConsoleNoAnsi(boolean)" class="member-name-link">withNoConsoleNoAnsi</a><wbr>(boolean&nbsp;noConsoleNoAnsi)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 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><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withPattern(java.lang.String)" class="member-name-link">withPattern</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;pattern)</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-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#withPatternSelector(org.apache.logging.log4j.core.layout.PatternSelector)" class="member-name-link">withPatternSelector</a><wbr>(<a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a>&nbsp;patternSelector)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 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><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withRegexReplacement(org.apache.logging.log4j.core.pattern.RegexReplacement)" class="member-name-link">withRegexReplacement</a><wbr>(<a href="../pattern/RegexReplacement.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacement</a>&nbsp;regexReplacement)</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-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.util.Builder">Methods inherited from interface&nbsp;org.apache.logging.log4j.core.util.<a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a></h3>
 <code><a href="../util/Builder.html#getErrorPrefix()">getErrorPrefix</a>, <a href="../util/Builder.html#isValid()">isValid</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="withPattern(java.lang.String)">
 <h3>withPattern</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withPattern</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;pattern)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>pattern</code> - The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withPatternSelector(org.apache.logging.log4j.core.layout.PatternSelector)">
 <h3>withPatternSelector</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withPatternSelector</span><wbr><span class="parameters">(<a href="PatternSelector.html" title="interface in org.apache.logging.log4j.core.layout">PatternSelector</a>&nbsp;patternSelector)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>patternSelector</code> - Allows different patterns to be used based on some selection criteria.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withConfiguration(org.apache.logging.log4j.core.config.Configuration)">
 <h3>withConfiguration</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withConfiguration</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>configuration</code> - The Configuration. Some Converters require access to the Interpolator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withRegexReplacement(org.apache.logging.log4j.core.pattern.RegexReplacement)">
 <h3>withRegexReplacement</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withRegexReplacement</span><wbr><span class="parameters">(<a href="../pattern/RegexReplacement.html" title="class in org.apache.logging.log4j.core.pattern">RegexReplacement</a>&nbsp;regexReplacement)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>regexReplacement</code> - A Regex replacement</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withCharset(java.nio.charset.Charset)">
 <h3>withCharset</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withCharset</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>charset</code> - The character set. The platform default is used if not specified.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withAlwaysWriteExceptions(boolean)">
 <h3>withAlwaysWriteExceptions</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withAlwaysWriteExceptions</span><wbr><span class="parameters">(boolean&nbsp;alwaysWriteExceptions)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>alwaysWriteExceptions</code> - If <code>"true"</code> (default) exceptions are always written even if the pattern contains no exception tokens.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withDisableAnsi(boolean)">
 <h3>withDisableAnsi</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withDisableAnsi</span><wbr><span class="parameters">(boolean&nbsp;disableAnsi)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>disableAnsi</code> - If <code>"true"</code> (default is value of system property `log4j.skipJansi`, or `true` if undefined),
         do not output ANSI escape codes</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withNoConsoleNoAnsi(boolean)">
 <h3>withNoConsoleNoAnsi</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withNoConsoleNoAnsi</span><wbr><span class="parameters">(boolean&nbsp;noConsoleNoAnsi)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <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>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withHeader(java.lang.String)">
 <h3>withHeader</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withHeader</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;header)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>header</code> - The header to place at the top of the document, once.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withFooter(java.lang.String)">
 <h3>withFooter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></span>&nbsp;<span class="element-name">withFooter</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;footer)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>footer</code> - The footer to place at the bottom of the document, once.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="build()">
 <h3>build</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a></span>&nbsp;<span class="element-name">build</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../util/Builder.html#build()">Builder</a></code></span></div>
 <div class="block">Builds the object after all configuration has been set. This will use default values for any
  unspecified attributes for the object.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../util/Builder.html#build()">build</a></code>&nbsp;in interface&nbsp;<code><a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a>&lt;<a href="PatternLayout.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout</a>&gt;</code></dd>
 <dt>Returns:</dt>
 <dd>the configured instance.</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>