| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Builder (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.util, interface: Builder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Builder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </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.util</a></div> |
| <h1 title="Interface Builder" class="title">Interface Builder<T></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - This builder creates instances of this class.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../config/builder/api/AppenderComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderComponentBuilder</a></code>, <code><a href="../config/builder/api/AppenderRefComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">AppenderRefComponentBuilder</a></code>, <code><a href="../config/builder/api/ComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ComponentBuilder</a><T></code>, <code><a href="../config/builder/api/CompositeFilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CompositeFilterComponentBuilder</a></code>, <code><a href="../config/builder/api/ConfigurationBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ConfigurationBuilder</a><T></code>, <code><a href="../config/builder/api/CustomLevelComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">CustomLevelComponentBuilder</a></code>, <code><a href="../config/builder/api/FilterableComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterableComponentBuilder</a><T></code>, <code><a href="../config/builder/api/FilterComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">FilterComponentBuilder</a></code>, <code><a href="../config/builder/api/KeyValuePairComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">KeyValuePairComponentBuilder</a></code>, <code><a href="../config/builder/api/LayoutComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LayoutComponentBuilder</a></code>, <code><a href="../config/builder/api/LoggableComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggableComponentBuilder</a><T></code>, <code><a href="../config/builder/api/LoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">LoggerComponentBuilder</a></code>, <code><a href="../config/builder/api/PropertyComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">PropertyComponentBuilder</a></code>, <code><a href="../config/builder/api/RootLoggerComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">RootLoggerComponentBuilder</a></code>, <code><a href="../config/builder/api/ScriptComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptComponentBuilder</a></code>, <code><a href="../config/builder/api/ScriptFileComponentBuilder.html" title="interface in org.apache.logging.log4j.core.config.builder.api">ScriptFileComponentBuilder</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../appender/AppenderSet.Builder.html" title="class in org.apache.logging.log4j.core.appender">AppenderSet.Builder</a></code>, <code><a href="../appender/AsyncAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender.Builder</a></code>, <code><a href="../async/AsyncLoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig.Builder</a></code>, <code><a href="../async/AsyncLoggerConfig.RootLogger.Builder.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig.RootLogger.Builder</a></code>, <code><a href="../async/AsyncWaitStrategyFactoryConfig.Builder.html" title="class in org.apache.logging.log4j.core.async">AsyncWaitStrategyFactoryConfig.Builder</a></code>, <code><a href="../filter/BurstFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">BurstFilter.Builder</a></code>, <code><a href="../config/arbiters/ClassArbiter.Builder.html" title="class in org.apache.logging.log4j.core.config.arbiters">ClassArbiter.Builder</a></code>, <code><a href="../appender/db/jdbc/ColumnConfig.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig.Builder</a></code>, <code><a href="../appender/db/ColumnMapping.Builder.html" title="class in org.apache.logging.log4j.core.appender.db">ColumnMapping.Builder</a></code>, <code><a href="../appender/ConsoleAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">ConsoleAppender.Builder</a></code>, <code><a href="../config/arbiters/DefaultArbiter.Builder.html" title="class in org.apache.logging.log4j.core.config.arbiters">DefaultArbiter.Builder</a></code>, <code><a href="../config/builder/impl/DefaultConfigurationBuilder.html" title="class in org.apache.logging.log4j.core.config.builder.impl">DefaultConfigurationBuilder</a></code>, <code><a href="../appender/rolling/DefaultRolloverStrategy.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling">DefaultRolloverStrategy.Builder</a></code>, <code><a href="../filter/DenyAllFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">DenyAllFilter.Builder</a></code>, <code><a href="../appender/rolling/DirectWriteRolloverStrategy.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling">DirectWriteRolloverStrategy.Builder</a></code>, <code><a href="../appender/db/jdbc/DriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a></code>, <code><a href="../config/arbiters/EnvironmentArbiter.Builder.html" title="class in org.apache.logging.log4j.core.config.arbiters">EnvironmentArbiter.Builder</a></code>, <code><a href="../appender/FileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">FileAppender.Builder</a></code>, <code><a href="../layout/GelfLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">GelfLayout.Builder</a></code>, <code><a href="../layout/HtmlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">HtmlLayout.Builder</a></code>, <code><a href="../appender/HttpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">HttpAppender.Builder</a></code>, <code><a href="../appender/db/jdbc/JdbcAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender.Builder</a></code>, <code><a href="../appender/mom/JmsAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender.Builder</a></code>, <code><a href="../layout/JsonLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">JsonLayout.Builder</a></code>, <code><a href="../appender/mom/kafka/KafkaAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.mom.kafka">KafkaAppender.Builder</a></code>, <code><a href="KeyValuePair.Builder.html" title="class in org.apache.logging.log4j.core.util">KeyValuePair.Builder</a></code>, <code><a href="../filter/LevelMatchFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">LevelMatchFilter.Builder</a></code>, <code><a href="../layout/LevelPatternSelector.Builder.html" title="class in org.apache.logging.log4j.core.layout">LevelPatternSelector.Builder</a></code>, <code><a href="../impl/Log4jLogEvent.Builder.html" title="class in org.apache.logging.log4j.core.impl">Log4jLogEvent.Builder</a></code>, <code><a href="../config/LoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a></code>, <code><a href="../config/LoggerConfig.RootLogger.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger.Builder</a></code>, <code><a href="../layout/MarkerPatternSelector.Builder.html" title="class in org.apache.logging.log4j.core.layout">MarkerPatternSelector.Builder</a></code>, <code><a href="../appender/MemoryMappedFileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">MemoryMappedFileAppender.Builder</a></code>, <code><a href="../net/MimeMessageBuilder.html" title="class in org.apache.logging.log4j.core.net">MimeMessageBuilder</a></code>, <code><a href="../filter/MutableThreadContextMapFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">MutableThreadContextMapFilter.Builder</a></code>, <code><a href="../filter/NoMarkerFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">NoMarkerFilter.Builder</a></code>, <code><a href="../appender/nosql/NoSqlAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.nosql">NoSqlAppender.Builder</a></code>, <code><a href="../appender/OutputStreamAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamAppender.Builder</a></code>, <code><a href="../layout/PatternLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.Builder</a></code>, <code><a href="../layout/PatternLayout.SerializerBuilder.html" title="class in org.apache.logging.log4j.core.layout">PatternLayout.SerializerBuilder</a></code>, <code><a href="../layout/PatternMatch.Builder.html" title="class in org.apache.logging.log4j.core.layout">PatternMatch.Builder</a></code>, <code><a href="../config/plugins/util/PluginBuilder.html" title="class in org.apache.logging.log4j.core.config.plugins.util">PluginBuilder</a></code>, <code><a href="../appender/rolling/action/PosixViewAttributeAction.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling.action">PosixViewAttributeAction.Builder</a></code>, <code><a href="../config/properties/PropertiesConfigurationBuilder.html" title="class in org.apache.logging.log4j.core.config.properties">PropertiesConfigurationBuilder</a></code>, <code><a href="../appender/RandomAccessFileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">RandomAccessFileAppender.Builder</a></code>, <code><a href="../appender/RollingFileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">RollingFileAppender.Builder</a></code>, <code><a href="../appender/RollingRandomAccessFileAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">RollingRandomAccessFileAppender.Builder</a></code>, <code><a href="../appender/routing/Routes.Builder.html" title="class in org.apache.logging.log4j.core.appender.routing">Routes.Builder</a></code>, <code><a href="../appender/routing/RoutingAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.routing">RoutingAppender.Builder</a></code>, <code><a href="../appender/ScriptAppenderSelector.Builder.html" title="class in org.apache.logging.log4j.core.appender">ScriptAppenderSelector.Builder</a></code>, <code><a href="../config/arbiters/ScriptArbiter.Builder.html" title="class in org.apache.logging.log4j.core.config.arbiters">ScriptArbiter.Builder</a></code>, <code><a href="../layout/ScriptPatternSelector.Builder.html" title="class in org.apache.logging.log4j.core.layout">ScriptPatternSelector.Builder</a></code>, <code><a href="../config/arbiters/SelectArbiter.Builder.html" title="class in org.apache.logging.log4j.core.config.arbiters">SelectArbiter.Builder</a></code>, <code><a href="../appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code>, <code><a href="../net/SocketAddress.Builder.html" title="class in org.apache.logging.log4j.core.net">SocketAddress.Builder</a></code>, <code><a href="../appender/SocketAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender.Builder</a></code>, <code><a href="../net/SocketOptions.html" title="class in org.apache.logging.log4j.core.net">SocketOptions</a></code>, <code><a href="../net/SocketPerformancePreferences.html" title="class in org.apache.logging.log4j.core.net">SocketPerformancePreferences</a></code>, <code><a href="../filter/StringMatchFilter.Builder.html" title="class in org.apache.logging.log4j.core.filter">StringMatchFilter.Builder</a></code>, <code><a href="../appender/SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a></code>, <code><a href="../layout/SyslogLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">SyslogLayout.Builder</a></code>, <code><a href="../config/arbiters/SystemPropertyArbiter.Builder.html" title="class in org.apache.logging.log4j.core.config.arbiters">SystemPropertyArbiter.Builder</a></code>, <code><a href="../appender/rolling/TimeBasedTriggeringPolicy.Builder.html" title="class in org.apache.logging.log4j.core.appender.rolling">TimeBasedTriggeringPolicy.Builder</a></code>, <code><a href="../appender/WriterAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">WriterAppender.Builder</a></code>, <code><a href="../layout/XmlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">XmlLayout.Builder</a></code>, <code><a href="../layout/YamlLayout.Builder.html" title="class in org.apache.logging.log4j.core.layout">YamlLayout.Builder</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Builder<T></span></div> |
| <div class="block">A type of builder that can be used to configure and create a instances using a Java DSL instead of |
| through a configuration file. These builders are primarily useful for internal code and unit tests, but they can |
| technically be used as a verbose alternative to configuration files. |
| |
| <p> |
| When creating <em>plugin</em> builders, it is customary to create the builder class as a public static inner class |
| called <code>Builder</code>. For instance, the builder class for |
| <a href="../layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>PatternLayout</code></a> would be |
| <code>PatternLayout.Builder</code>. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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="Builder.html" title="type parameter in Builder">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="#build()" class="member-name-link">build</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Builds the object after all configuration has been set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <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-tab5"><code><a href="#getErrorPrefix()" class="member-name-link">getErrorPrefix</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Prefix to use to report errors from this builder.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isValid()" class="member-name-link">isValid</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| </div> |
| </div> |
| </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="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="return-type"><a href="Builder.html" title="type parameter in Builder">T</a></span> <span class="element-name">build</span>()</div> |
| <div class="block">Builds the object after all configuration has been set. This will use default values for any |
| unspecified attributes for the object.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../config/ConfigurationException.html" title="class in org.apache.logging.log4j.core.config">ConfigurationException</a></code> - if there was an error building the |
| object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid()"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorPrefix()"> |
| <h3>getErrorPrefix</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getErrorPrefix</span>()</div> |
| <div class="block">Prefix to use to report errors from this builder.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The prefix of all logged errors.</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> |
