| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ConfigurationBuilder (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.config.builder.api, interface: ConfigurationBuilder"> |
| <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/ConfigurationBuilder.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </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.config.builder.api</a></div> |
| <h1 title="Interface ConfigurationBuilder" class="title">Interface ConfigurationBuilder<T extends <a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The Configuration type created by this builder.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../../../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a><T></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../impl/DefaultConfigurationBuilder.html" title="class in org.apache.logging.log4j.core.config.builder.impl">DefaultConfigurationBuilder</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ConfigurationBuilder<T extends <a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>></span><span class="extends-implements"> |
| extends <a href="../../../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a><T></span></div> |
| <div class="block">Interface for building logging configurations.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.4</dd> |
| </dl> |
| </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="AppenderComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderComponentBuilder</a> builder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds an AppenderComponent.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.CustomLevelComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="CustomLevelComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CustomLevelComponentBuilder</a> builder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a CustomLevel component.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.FilterComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a> builder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a Filter component.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.LoggerComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a> builder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a Logger component.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.RootLoggerComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a> builder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds the root Logger component.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.ScriptComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="ScriptComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptComponentBuilder</a> builder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a ScriptComponent.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#add(org.apache.logging.log4j.core.config.builder.api.ScriptFileComponentBuilder)" class="member-name-link">add</a><wbr>(<a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a> builder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a ScriptFileComponent.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addProperty(java.lang.String,java.lang.String)" class="member-name-link">addProperty</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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a Property key and value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addRootProperty(java.lang.String,java.lang.String)" class="member-name-link">addRootProperty</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> key, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Add the properties for the root node.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#build(boolean)" class="member-name-link">build</a><wbr>(boolean initialize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Build the configuration and optionally initialize it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AppenderComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAppender(java.lang.String,java.lang.String)" class="member-name-link">newAppender</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> name, |
| <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> pluginName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Appenders.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AppenderRefComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderRefComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAppenderRef(java.lang.String)" class="member-name-link">newAppenderRef</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> ref)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating AppenderRefs.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncLogger(java.lang.String)" class="member-name-link">newAsyncLogger</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncLogger(java.lang.String,boolean)" class="member-name-link">newAsyncLogger</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> name, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncLogger(java.lang.String,java.lang.String)" class="member-name-link">newAsyncLogger</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> name, |
| <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> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncLogger(java.lang.String,java.lang.String,boolean)" class="member-name-link">newAsyncLogger</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> name, |
| <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> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncLogger(java.lang.String,org.apache.logging.log4j.Level)" class="member-name-link">newAsyncLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncLogger(java.lang.String,org.apache.logging.log4j.Level,boolean)" class="member-name-link">newAsyncLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncRootLogger()" class="member-name-link">newAsyncRootLogger</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncRootLogger(boolean)" class="member-name-link">newAsyncRootLogger</a><wbr>(boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncRootLogger(java.lang.String)" class="member-name-link">newAsyncRootLogger</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> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncRootLogger(java.lang.String,boolean)" class="member-name-link">newAsyncRootLogger</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> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncRootLogger(org.apache.logging.log4j.Level)" class="member-name-link">newAsyncRootLogger</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newAsyncRootLogger(org.apache.logging.log4j.Level,boolean)" class="member-name-link">newAsyncRootLogger</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><B extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B>><br><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newComponent(java.lang.String)" class="member-name-link">newComponent</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> pluginName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating generic components.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><B extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B>><br><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newComponent(java.lang.String,java.lang.String)" class="member-name-link">newComponent</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> name, |
| <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> pluginName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating generic components.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><B extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B>><br><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newComponent(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">newComponent</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> name, |
| <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> pluginName, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating generic components.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="CustomLevelComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CustomLevelComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newCustomLevel(java.lang.String,int)" class="member-name-link">newCustomLevel</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> name, |
| int level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating CustomLevels</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newFilter(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">newFilter</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> pluginName, |
| <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> onMatch, |
| <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> onMismatch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Filters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newFilter(java.lang.String,org.apache.logging.log4j.core.Filter.Result,org.apache.logging.log4j.core.Filter.Result)" class="member-name-link">newFilter</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> pluginName, |
| <a href="../../../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> onMatch, |
| <a href="../../../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> onMismatch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Filters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="KeyValuePairComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">KeyValuePairComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newKeyValuePair(java.lang.String,java.lang.String)" class="member-name-link">newKeyValuePair</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> key, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating KeyValuePair:s</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LayoutComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LayoutComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLayout(java.lang.String)" class="member-name-link">newLayout</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> pluginName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Layouts.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLogger(java.lang.String)" class="member-name-link">newLogger</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLogger(java.lang.String,boolean)" class="member-name-link">newLogger</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> name, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLogger(java.lang.String,java.lang.String)" class="member-name-link">newLogger</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> name, |
| <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> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLogger(java.lang.String,java.lang.String,boolean)" class="member-name-link">newLogger</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> name, |
| <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> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLogger(java.lang.String,org.apache.logging.log4j.Level)" class="member-name-link">newLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newLogger(java.lang.String,org.apache.logging.log4j.Level,boolean)" class="member-name-link">newLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PropertyComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">PropertyComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newProperty(java.lang.String,java.lang.String)" class="member-name-link">newProperty</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> name, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Property:s</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newRootLogger()" class="member-name-link">newRootLogger</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newRootLogger(boolean)" class="member-name-link">newRootLogger</a><wbr>(boolean includeLocation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newRootLogger(java.lang.String)" class="member-name-link">newRootLogger</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> level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newRootLogger(java.lang.String,boolean)" class="member-name-link">newRootLogger</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> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newRootLogger(org.apache.logging.log4j.Level)" class="member-name-link">newRootLogger</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newRootLogger(org.apache.logging.log4j.Level,boolean)" class="member-name-link">newRootLogger</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ScriptComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newScript(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">newScript</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> name, |
| <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> language, |
| <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> text)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newScriptFile(java.lang.String)" class="member-name-link">newScriptFile</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> path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newScriptFile(java.lang.String,java.lang.String)" class="member-name-link">newScriptFile</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> name, |
| <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> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAdvertiser(java.lang.String)" class="member-name-link">setAdvertiser</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> advertiser)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the Advertiser Plugin name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setConfigurationName(java.lang.String)" class="member-name-link">setConfigurationName</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> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the name of the configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setConfigurationSource(org.apache.logging.log4j.core.config.ConfigurationSource)" class="member-name-link">setConfigurationSource</a><wbr>(<a href="../../ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configurationSource)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the configuration source, if one exists.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDestination(java.lang.String)" class="member-name-link">setDestination</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> destination)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Specifies the destination for StatusLogger events.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLoggerContext(org.apache.logging.log4j.core.LoggerContext)" class="member-name-link">setLoggerContext</a><wbr>(<a href="../../../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the logger context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMonitorInterval(java.lang.String)" class="member-name-link">setMonitorInterval</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> intervalSeconds)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the interval at which the configuration file should be checked for changes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setPackages(java.lang.String)" class="member-name-link">setPackages</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> packages)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the list of packages to search for plugins.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setShutdownHook(java.lang.String)" class="member-name-link">setShutdownHook</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> flag)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets whether the shutdown hook should be disabled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setShutdownTimeout(long,java.util.concurrent.TimeUnit)" class="member-name-link">setShutdownTimeout</a><wbr>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">How long appenders and background tasks will get to shutdown when the JVM shuts down.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setStatusLevel(org.apache.logging.log4j.Level)" class="member-name-link">setStatusLevel</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the level of the StatusLogger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setVerbosity(java.lang.String)" class="member-name-link">setVerbosity</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> verbosity)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets whether the logging should include constructing Plugins.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toXmlConfiguration()" class="member-name-link">toXmlConfiguration</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Constructs an XML configuration from this builder.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeXmlConfiguration(java.io.OutputStream)" class="member-name-link">writeXmlConfiguration</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> output)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Constructs an XML configuration from this builder.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.util.Builder">Methods inherited from interface 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#build()">build</a>, <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="add(org.apache.logging.log4j.core.config.builder.api.ScriptComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="ScriptComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds a ScriptComponent.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The ScriptComponentBuilder with all of its attributes and sub components set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.logging.log4j.core.config.builder.api.ScriptFileComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds a ScriptFileComponent.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The ScriptFileComponentBuilder with all of its attributes and sub components set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="AppenderComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds an AppenderComponent.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The AppenderComponentBuilder with all of its attributes and sub components set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.logging.log4j.core.config.builder.api.CustomLevelComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="CustomLevelComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CustomLevelComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds a CustomLevel component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The CustomLevelComponentBuilder with all of its attributes set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.logging.log4j.core.config.builder.api.FilterComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds a Filter component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - the FilterComponentBuilder with all of its attributes and sub components set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.logging.log4j.core.config.builder.api.LoggerComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds a Logger component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The LoggerComponentBuilder with all of its attributes and sub components set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.logging.log4j.core.config.builder.api.RootLoggerComponentBuilder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a> builder)</span></div> |
| <div class="block">Adds the root Logger component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The RootLoggerComponentBuilder with all of its attributes and sub components set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addProperty(java.lang.String,java.lang.String)"> |
| <h3>addProperty</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">addProperty</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> key, |
| <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> value)</span></div> |
| <div class="block">Adds a Property key and value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The property key.</dd> |
| <dd><code>value</code> - The property value.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newScript(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>newScript</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScriptComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptComponentBuilder</a></span> <span class="element-name">newScript</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> name, |
| <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> language, |
| <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> text)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>language</code> - The script language</dd> |
| <dd><code>text</code> - The script to execute.</dd> |
| <dt>Returns:</dt> |
| <dd>A new ScriptComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newScriptFile(java.lang.String)"> |
| <h3>newScriptFile</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a></span> <span class="element-name">newScriptFile</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> path)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The location of the script file.</dd> |
| <dt>Returns:</dt> |
| <dd>A new ScriptFileComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newScriptFile(java.lang.String,java.lang.String)"> |
| <h3>newScriptFile</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a></span> <span class="element-name">newScriptFile</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> name, |
| <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> path)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the script file.</dd> |
| <dd><code>path</code> - The location of the script file.</dd> |
| <dt>Returns:</dt> |
| <dd>A new ScriptFileComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAppender(java.lang.String,java.lang.String)"> |
| <h3>newAppender</h3> |
| <div class="member-signature"><span class="return-type"><a href="AppenderComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderComponentBuilder</a></span> <span class="element-name">newAppender</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> name, |
| <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> pluginName)</span></div> |
| <div class="block">Returns a builder for creating Appenders.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Appender.</dd> |
| <dd><code>pluginName</code> - The Plugin type of the Appender.</dd> |
| <dt>Returns:</dt> |
| <dd>A new AppenderComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAppenderRef(java.lang.String)"> |
| <h3>newAppenderRef</h3> |
| <div class="member-signature"><span class="return-type"><a href="AppenderRefComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderRefComponentBuilder</a></span> <span class="element-name">newAppenderRef</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> ref)</span></div> |
| <div class="block">Returns a builder for creating AppenderRefs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ref</code> - The name of the Appender being referenced.</dd> |
| <dt>Returns:</dt> |
| <dd>A new AppenderRefComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncLogger(java.lang.String)"> |
| <h3>newAsyncLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newAsyncLogger</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> name)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncLogger(java.lang.String,boolean)"> |
| <h3>newAsyncLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newAsyncLogger</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> name, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncLogger(java.lang.String,org.apache.logging.log4j.Level)"> |
| <h3>newAsyncLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newAsyncLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncLogger(java.lang.String,org.apache.logging.log4j.Level,boolean)"> |
| <h3>newAsyncLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newAsyncLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncLogger(java.lang.String,java.lang.String)"> |
| <h3>newAsyncLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newAsyncLogger</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> name, |
| <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> level)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncLogger(java.lang.String,java.lang.String,boolean)"> |
| <h3>newAsyncLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newAsyncLogger</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> name, |
| <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> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating Async Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncRootLogger()"> |
| <h3>newAsyncRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newAsyncRootLogger</span>()</div> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncRootLogger(boolean)"> |
| <h3>newAsyncRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newAsyncRootLogger</span><wbr><span class="parameters">(boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncRootLogger(org.apache.logging.log4j.Level)"> |
| <h3>newAsyncRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newAsyncRootLogger</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</span></div> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncRootLogger(org.apache.logging.log4j.Level,boolean)"> |
| <h3>newAsyncRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newAsyncRootLogger</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncRootLogger(java.lang.String)"> |
| <h3>newAsyncRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newAsyncRootLogger</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> level)</span></div> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newAsyncRootLogger(java.lang.String,boolean)"> |
| <h3>newAsyncRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newAsyncRootLogger</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> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating the async root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newComponent(java.lang.String)"> |
| <h3>newComponent</h3> |
| <div class="member-signature"><span class="type-parameters"><B extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B>></span> <span class="return-type"><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B></span> <span class="element-name">newComponent</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> pluginName)</span></div> |
| <div class="block">Returns a builder for creating generic components.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>B</code> - ComponentBuilder target type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>pluginName</code> - The Plugin type of the component.</dd> |
| <dt>Returns:</dt> |
| <dd>A new ComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newComponent(java.lang.String,java.lang.String)"> |
| <h3>newComponent</h3> |
| <div class="member-signature"><span class="type-parameters"><B extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B>></span> <span class="return-type"><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B></span> <span class="element-name">newComponent</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> name, |
| <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> pluginName)</span></div> |
| <div class="block">Returns a builder for creating generic components.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>B</code> - ComponentBuilder target type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the component (may be null).</dd> |
| <dd><code>pluginName</code> - The Plugin type of the component.</dd> |
| <dt>Returns:</dt> |
| <dd>A new ComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newComponent(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>newComponent</h3> |
| <div class="member-signature"><span class="type-parameters"><B extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B>></span> <span class="return-type"><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><B></span> <span class="element-name">newComponent</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> name, |
| <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> pluginName, |
| <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> value)</span></div> |
| <div class="block">Returns a builder for creating generic components.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>B</code> - ComponentBuilder target type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the component (may be null).</dd> |
| <dd><code>pluginName</code> - The Plugin type of the component.</dd> |
| <dd><code>value</code> - The value of the component.</dd> |
| <dt>Returns:</dt> |
| <dd>A new ComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newProperty(java.lang.String,java.lang.String)"> |
| <h3>newProperty</h3> |
| <div class="member-signature"><span class="return-type"><a href="PropertyComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">PropertyComponentBuilder</a></span> <span class="element-name">newProperty</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> name, |
| <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> value)</span></div> |
| <div class="block">Returns a builder for creating Property:s</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the property.</dd> |
| <dd><code>value</code> - The value of the component.</dd> |
| <dt>Returns:</dt> |
| <dd>A new PropertyComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newKeyValuePair(java.lang.String,java.lang.String)"> |
| <h3>newKeyValuePair</h3> |
| <div class="member-signature"><span class="return-type"><a href="KeyValuePairComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">KeyValuePairComponentBuilder</a></span> <span class="element-name">newKeyValuePair</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> key, |
| <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> value)</span></div> |
| <div class="block">Returns a builder for creating KeyValuePair:s</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The name</dd> |
| <dd><code>value</code> - The value</dd> |
| <dt>Returns:</dt> |
| <dd>A new KeyValuePairComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newCustomLevel(java.lang.String,int)"> |
| <h3>newCustomLevel</h3> |
| <div class="member-signature"><span class="return-type"><a href="CustomLevelComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CustomLevelComponentBuilder</a></span> <span class="element-name">newCustomLevel</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> name, |
| int level)</span></div> |
| <div class="block">Returns a builder for creating CustomLevels</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the custom level.</dd> |
| <dd><code>level</code> - The integer value to be assigned to the level.</dd> |
| <dt>Returns:</dt> |
| <dd>A new CustomLevelComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newFilter(java.lang.String,org.apache.logging.log4j.core.Filter.Result,org.apache.logging.log4j.core.Filter.Result)"> |
| <h3>newFilter</h3> |
| <div class="member-signature"><span class="return-type"><a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a></span> <span class="element-name">newFilter</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> pluginName, |
| <a href="../../../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> onMatch, |
| <a href="../../../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> onMismatch)</span></div> |
| <div class="block">Returns a builder for creating Filters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pluginName</code> - The Plugin type of the Filter.</dd> |
| <dd><code>onMatch</code> - "ACCEPT", "DENY", or "NEUTRAL"</dd> |
| <dd><code>onMismatch</code> - "ACCEPT", "DENY", or "NEUTRAL"</dd> |
| <dt>Returns:</dt> |
| <dd>A new FilterComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newFilter(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>newFilter</h3> |
| <div class="member-signature"><span class="return-type"><a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a></span> <span class="element-name">newFilter</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> pluginName, |
| <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> onMatch, |
| <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> onMismatch)</span></div> |
| <div class="block">Returns a builder for creating Filters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pluginName</code> - The Plugin type of the Filter.</dd> |
| <dd><code>onMatch</code> - "ACCEPT", "DENY", or "NEUTRAL"</dd> |
| <dd><code>onMismatch</code> - "ACCEPT", "DENY", or "NEUTRAL"</dd> |
| <dt>Returns:</dt> |
| <dd>A new FilterComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLayout(java.lang.String)"> |
| <h3>newLayout</h3> |
| <div class="member-signature"><span class="return-type"><a href="LayoutComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LayoutComponentBuilder</a></span> <span class="element-name">newLayout</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> pluginName)</span></div> |
| <div class="block">Returns a builder for creating Layouts.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pluginName</code> - The Plugin type of the Layout.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LayoutComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLogger(java.lang.String)"> |
| <h3>newLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newLogger</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> name)</span></div> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLogger(java.lang.String,boolean)"> |
| <h3>newLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newLogger</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> name, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLogger(java.lang.String,org.apache.logging.log4j.Level)"> |
| <h3>newLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</span></div> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLogger(java.lang.String,org.apache.logging.log4j.Level,boolean)"> |
| <h3>newLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newLogger</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> name, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLogger(java.lang.String,java.lang.String)"> |
| <h3>newLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newLogger</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> name, |
| <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> level)</span></div> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newLogger(java.lang.String,java.lang.String,boolean)"> |
| <h3>newLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></span> <span class="element-name">newLogger</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> name, |
| <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> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating Loggers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Logger.</dd> |
| <dd><code>level</code> - The logging Level to be assigned to the Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newRootLogger()"> |
| <h3>newRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newRootLogger</span>()</div> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newRootLogger(boolean)"> |
| <h3>newRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newRootLogger</span><wbr><span class="parameters">(boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newRootLogger(org.apache.logging.log4j.Level)"> |
| <h3>newRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newRootLogger</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</span></div> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newRootLogger(org.apache.logging.log4j.Level,boolean)"> |
| <h3>newRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newRootLogger</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dd><code>includeLocation</code> - If true include location information.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newRootLogger(java.lang.String)"> |
| <h3>newRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newRootLogger</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> level)</span></div> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newRootLogger(java.lang.String,boolean)"> |
| <h3>newRootLogger</h3> |
| <div class="member-signature"><span class="return-type"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></span> <span class="element-name">newRootLogger</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> level, |
| boolean includeLocation)</span></div> |
| <div class="block">Returns a builder for creating the root Logger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level to be assigned to the root Logger.</dd> |
| <dt>Returns:</dt> |
| <dd>A new RootLoggerComponentBuilder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAdvertiser(java.lang.String)"> |
| <h3>setAdvertiser</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setAdvertiser</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> advertiser)</span></div> |
| <div class="block">Set the Advertiser Plugin name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>advertiser</code> - The Advertiser Plugin name.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConfigurationName(java.lang.String)"> |
| <h3>setConfigurationName</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setConfigurationName</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> name)</span></div> |
| <div class="block">Sets the name of the configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the <a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config"><code>Configuration</code></a>. By default is <code>"Constructed"</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConfigurationSource(org.apache.logging.log4j.core.config.ConfigurationSource)"> |
| <h3>setConfigurationSource</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setConfigurationSource</span><wbr><span class="parameters">(<a href="../../ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> configurationSource)</span></div> |
| <div class="block">Sets the configuration source, if one exists.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configurationSource</code> - the ConfigurationSource.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMonitorInterval(java.lang.String)"> |
| <h3>setMonitorInterval</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setMonitorInterval</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> intervalSeconds)</span></div> |
| <div class="block">Sets the interval at which the configuration file should be checked for changes.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>intervalSeconds</code> - The number of seconds that should pass between checks of the configuration file.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPackages(java.lang.String)"> |
| <h3>setPackages</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setPackages</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> packages)</span></div> |
| <div class="block">Sets the list of packages to search for plugins.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packages</code> - The comma separated list of packages.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setShutdownHook(java.lang.String)"> |
| <h3>setShutdownHook</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setShutdownHook</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> flag)</span></div> |
| <div class="block">Sets whether the shutdown hook should be disabled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>flag</code> - "disable" will prevent the shutdown hook from being set.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setShutdownTimeout(long,java.util.concurrent.TimeUnit)"> |
| <h3>setShutdownTimeout</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setShutdownTimeout</span><wbr><span class="parameters">(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> timeUnit)</span></div> |
| <div class="block">How long appenders and background tasks will get to shutdown when the JVM shuts down. |
| Default is zero which mean that each appender uses its default timeout, and don't wait for background |
| tasks. Not all appenders will honor this, it is a hint and not an absolute guarantee that the shutdown |
| procedure will not take longer. Setting this too low increase the risk of losing outstanding log events |
| not yet written to the final destination. (Not used if <a href="#setShutdownHook(java.lang.String)"><code>setShutdownHook(String)</code></a> is set to "disable".)</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../../../LoggerContext.html#stop(long,java.util.concurrent.TimeUnit)"><code>LoggerContext.stop(long, TimeUnit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStatusLevel(org.apache.logging.log4j.Level)"> |
| <h3>setStatusLevel</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setStatusLevel</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Level.html" title="class or interface in org.apache.logging.log4j" class="external-link">Level</a> level)</span></div> |
| <div class="block">Sets the level of the StatusLogger.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging level.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVerbosity(java.lang.String)"> |
| <h3>setVerbosity</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setVerbosity</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> verbosity)</span></div> |
| <div class="block">Sets whether the logging should include constructing Plugins.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>verbosity</code> - "disable" will hide messages from plugin construction.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDestination(java.lang.String)"> |
| <h3>setDestination</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">setDestination</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> destination)</span></div> |
| <div class="block">Specifies the destination for StatusLogger events. This can be <code>out</code> (default) for using |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out" title="class or interface in java.lang" class="external-link"><code>standard out</code></a>, <code>err</code> for using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err" title="class or interface in java.lang" class="external-link"><code>standard error</code></a>, or a file URI to |
| which log events will be written. If the provided URI is invalid, then the default destination of standard |
| out will be used.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>destination</code> - where status log messages should be output.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLoggerContext(org.apache.logging.log4j.core.LoggerContext)"> |
| <h3>setLoggerContext</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setLoggerContext</span><wbr><span class="parameters">(<a href="../../../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> loggerContext)</span></div> |
| <div class="block">Sets the logger context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loggerContext</code> - the logger context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRootProperty(java.lang.String,java.lang.String)"> |
| <h3>addRootProperty</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><<a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a>></span> <span class="element-name">addRootProperty</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> key, |
| <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> value)</span></div> |
| <div class="block">Add the properties for the root node.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - The property key.</dd> |
| <dd><code>value</code> - The property value.</dd> |
| <dt>Returns:</dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build(boolean)"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConfigurationBuilder.html" title="type parameter in ConfigurationBuilder">T</a></span> <span class="element-name">build</span><wbr><span class="parameters">(boolean initialize)</span></div> |
| <div class="block">Build the configuration and optionally initialize it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>initialize</code> - true if the configuration should be initialized, false otherwise. Generally, Configurations |
| should not be initialized when they are constructed.</dd> |
| <dt>Returns:</dt> |
| <dd>The constructed Configuration.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeXmlConfiguration(java.io.OutputStream)"> |
| <h3>writeXmlConfiguration</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">writeXmlConfiguration</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a> output)</span> |
| throws <span class="exceptions"><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> |
| <div class="block">Constructs an XML configuration from this builder.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>output</code> - OutputStream to write to, will not be closed</dd> |
| <dt>Throws:</dt> |
| <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> |
| <dt>Since:</dt> |
| <dd>2.7</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toXmlConfiguration()"> |
| <h3>toXmlConfiguration</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toXmlConfiguration</span>()</div> |
| <div class="block">Constructs an XML configuration from this builder.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>XML configuration</dd> |
| <dt>Since:</dt> |
| <dd>2.7</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 © 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> |
