blob: 5d16c73f644f9a3d933efa338f57ed1b61167542 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.config.builder.api (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li>Related Packages&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.logging.log4j.core.config.builder.api" class="title">Package org.apache.logging.log4j.core.config.builder.api</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.20.1")
</span>package <span class="element-name">org.apache.logging.log4j.core.config.builder.api</span></div>
<section class="package-description" id="package-description">
<div class="block">Configuration Builder API for programmatically configuring Log4j.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2.4</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="AppenderComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderComponentBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Builder for constructing Appender Components.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="AppenderRefComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderRefComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing AppenderRef Components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Component.html" title="class in org.apache.logging.log4j.core.config.builder.api">Component</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Container for building Configurations.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a>&lt;T extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a>&lt;T&gt;&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Builds arbitrary components and is the base type for the provided components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="CompositeFilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CompositeFilterComponentBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Wraps multiple Filter Component builders.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a>&lt;T extends <a href="../../Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for building logging configurations.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ConfigurationBuilderFactory.html" title="class in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilderFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Provides methods to create ConfigurationBuilders.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="CustomLevelComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CustomLevelComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing CustomLevel Components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="FilterableComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterableComponentBuilder</a>&lt;T extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a>&lt;T&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Component builder that can add Filters.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing Filter Components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="KeyValuePairComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">KeyValuePairComponentBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing KeyValuePair Components.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LayoutComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LayoutComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing Layout Components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LoggableComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggableComponentBuilder</a>&lt;T extends <a href="ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a>&lt;T&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Common component builder for Logger and RootLogger elements.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing Logger Components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="PropertyComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">PropertyComponentBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing Property Components.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing the root Logger Components.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ScriptComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptComponentBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing Layout Components.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Assembler for constructing ScriptFile Components.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>