| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>LoggerConfig (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, class: LoggerConfig"> |
| <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/LoggerConfig.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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</a></div> |
| <h1 title="Class LoggerConfig" class="title">Class LoggerConfig</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">org.apache.logging.log4j.core.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable</a> |
| <div class="inheritance">org.apache.logging.log4j.core.config.LoggerConfig</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></code>, <code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code>, <code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code>, <code><a href="../LifeCycle2.html" title="interface in org.apache.logging.log4j.core">LifeCycle2</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../async/AsyncLoggerConfig.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig</a></code>, <code><a href="../async/AsyncLoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.async">AsyncLoggerConfig.RootLogger</a></code>, <code><a href="LoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="plugins/Plugin.html#name()">name</a>="logger", |
| <a href="plugins/Plugin.html#category()">category</a>="Core", |
| <a href="plugins/Plugin.html#printObject()">printObject</a>=true) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">LoggerConfig</span> |
| <span class="extends-implements">extends <a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a> |
| implements <a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></span></div> |
| <div class="block">Logger object that is created via configuration.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="LoggerConfig.Builder.html" class="type-name-link" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a><<a href="LoggerConfig.Builder.html" title="type parameter in LoggerConfig.Builder">B</a> extends <a href="LoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a><<a href="LoggerConfig.Builder.html" title="type parameter in LoggerConfig.Builder">B</a>>></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Builds LoggerConfig instances.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="LoggerConfig.LevelAndRefs.html" class="type-name-link" title="class in org.apache.logging.log4j.core.config">LoggerConfig.LevelAndRefs</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="LoggerConfig.LoggerConfigPredicate.html" class="type-name-link" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="LoggerConfig.RootLogger.html" class="type-name-link" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The root Logger.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h2> |
| <code><a href="../LifeCycle.State.html" title="enum in org.apache.logging.log4j.core">LifeCycle.State</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#ROOT" class="member-name-link">ROOT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Fields inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a>, <a href="../AbstractLifeCycle.html#DEFAULT_STOP_TIMEUNIT">DEFAULT_STOP_TIMEUNIT</a>, <a href="../AbstractLifeCycle.html#LOGGER">LOGGER</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LoggerConfig</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default constructor.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.List,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.Level,boolean,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.config.Configuration,boolean)" class="member-name-link">LoggerConfig</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>> appenders, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| <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 additive, |
| <a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| boolean includeLocation)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.logging.log4j.Level,boolean)" class="member-name-link">LoggerConfig</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 additive)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructor that sets the name, level and additive values.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAppender(org.apache.logging.log4j.core.Appender,org.apache.logging.log4j.Level,org.apache.logging.log4j.core.Filter)" class="member-name-link">addAppender</a><wbr>(<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a> appender, |
| <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, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds an Appender to the LoggerConfig.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#callAppenders(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">callAppenders</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearAppenders()" class="member-name-link">clearAppenders</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes all Appenders.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createLogger(boolean,org.apache.logging.log4j.Level,java.lang.String,java.lang.String,org.apache.logging.log4j.core.config.AppenderRef%5B%5D,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.Filter)" class="member-name-link">createLogger</a><wbr>(boolean additivity, |
| <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, |
| <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> loggerName, |
| <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> includeLocation, |
| <a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] refs, |
| <a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createLogger(java.lang.String,org.apache.logging.log4j.Level,java.lang.String,java.lang.String,org.apache.logging.log4j.core.config.AppenderRef%5B%5D,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.Filter)" class="member-name-link">createLogger</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> additivity, |
| <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, |
| <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> loggerName, |
| <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> includeLocation, |
| <a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] refs, |
| <a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Deprecated in 2.7; use <a href="#createLogger(boolean,org.apache.logging.log4j.Level,java.lang.String,java.lang.String,org.apache.logging.log4j.core.config.AppenderRef%5B%5D,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.Filter)"><code>createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)</code></a></div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppenderRefs()" class="member-name-link">getAppenderRefs</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the Appender references.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppenders()" class="member-name-link">getAppenders</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns all Appenders as a Map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExplicitLevel()" class="member-name-link">getExplicitLevel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allows callers to determine the Level assigned to this LoggerConfig.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFilter()" class="member-name-link">getFilter</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the Filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLevel()" class="member-name-link">getLevel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the logging Level.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <a href="LoggerConfig.LevelAndRefs.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.LevelAndRefs</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLevelAndRefs(org.apache.logging.log4j.Level,org.apache.logging.log4j.core.config.AppenderRef%5B%5D,java.lang.String,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">getLevelAndRefs</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, |
| <a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] refs, |
| <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> levelAndRefs, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../impl/LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLogEventFactory()" class="member-name-link">getLogEventFactory</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the LogEventFactory.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name of the LoggerConfig.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParent()" class="member-name-link">getParent</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the parent of this LoggerConfig.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getProperties()" class="member-name-link">getProperties</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#getPropertyList()"><code>getPropertyList()</code></a> instead</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPropertyList()" class="member-name-link">getPropertyList</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an unmodifiable list with the configuration properties, or <code>null</code> if this <code>LoggerConfig</code> does |
| not have any configuration properties.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">ReliabilityStrategy</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReliabilityStrategy()" class="member-name-link">getReliabilityStrategy</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the object responsible for ensuring log events are delivered to a working appender, even during or after |
| a reconfiguration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasAppenders()" class="member-name-link">hasAppenders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#includeLocation(java.lang.String)" class="member-name-link">includeLocation</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> includeLocationConfigValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#includeLocation(java.lang.String,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">includeLocation</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> includeLocationConfigValue, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAdditive()" class="member-name-link">isAdditive</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the valid of the additive flag.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIncludeLocation()" class="member-name-link">isIncludeLocation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value of logger configuration attribute <code>includeLocation</code>, or, if no such attribute was |
| configured, <code>true</code> if logging is synchronous or <code>false</code> if logging is asynchronous.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPropertiesRequireLookup()" class="member-name-link">isPropertiesRequireLookup</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(java.lang.String,java.lang.String,java.lang.StackTraceElement,org.apache.logging.log4j.Marker,org.apache.logging.log4j.Level,org.apache.logging.log4j.message.Message,java.lang.Throwable)" class="member-name-link">log</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> loggerName, |
| <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> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a> location, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">Message</a> data, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> t)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs an event.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(java.lang.String,java.lang.String,org.apache.logging.log4j.Marker,org.apache.logging.log4j.Level,org.apache.logging.log4j.message.Message,java.lang.Throwable)" class="member-name-link">log</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> loggerName, |
| <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> fqcn, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">Message</a> data, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> t)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs an event.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">log</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs an event.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#log(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.config.LoggerConfig.LoggerConfigPredicate)" class="member-name-link">log</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="LoggerConfig.LoggerConfigPredicate.html" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a> predicate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs an event.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <B extends <a href="LoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a><B>><br>B</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#processLogEvent(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.config.LoggerConfig.LoggerConfigPredicate)" class="member-name-link">processLogEvent</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="LoggerConfig.LoggerConfigPredicate.html" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a> predicate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs an event, bypassing filters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeAppender(java.lang.String)" class="member-name-link">removeAppender</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-tab4"> |
| <div class="block">Removes the Appender with the specific name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requiresLocation()" class="member-name-link">requiresLocation</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAdditive(boolean)" class="member-name-link">setAdditive</a><wbr>(boolean additive)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the additive setting.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLevel(org.apache.logging.log4j.Level)" class="member-name-link">setLevel</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-tab4"> |
| <div class="block">Sets the logging Level.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLogEventFactory(org.apache.logging.log4j.core.impl.LogEventFactory)" class="member-name-link">setLogEventFactory</a><wbr>(<a href="../impl/LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a> logEventFactory)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the LogEventFactory.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setParent(org.apache.logging.log4j.core.config.LoggerConfig)" class="member-name-link">setParent</a><wbr>(<a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a> parent)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the parent of this LoggerConfig.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilterable">Methods inherited from class org.apache.logging.log4j.core.filter.<a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></h3> |
| <code><a href="../filter/AbstractFilterable.html#addFilter(org.apache.logging.log4j.core.Filter)">addFilter</a>, <a href="../filter/AbstractFilterable.html#getPropertyArray()">getPropertyArray</a>, <a href="../filter/AbstractFilterable.html#hasFilter()">hasFilter</a>, <a href="../filter/AbstractFilterable.html#isFiltered(org.apache.logging.log4j.core.LogEvent)">isFiltered</a>, <a href="../filter/AbstractFilterable.html#removeFilter(org.apache.logging.log4j.core.Filter)">removeFilter</a>, <a href="../filter/AbstractFilterable.html#start()">start</a>, <a href="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit)">stop</a>, <a href="../filter/AbstractFilterable.html#stop(long,java.util.concurrent.TimeUnit,boolean)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.AbstractLifeCycle">Methods inherited from class org.apache.logging.log4j.core.<a href="../AbstractLifeCycle.html" title="class in org.apache.logging.log4j.core">AbstractLifeCycle</a></h3> |
| <code><a href="../AbstractLifeCycle.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="../AbstractLifeCycle.html#getState()">getState</a>, <a href="../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</a>, <a href="../AbstractLifeCycle.html#hashCodeImpl()">hashCodeImpl</a>, <a href="../AbstractLifeCycle.html#initialize()">initialize</a>, <a href="../AbstractLifeCycle.html#isInitialized()">isInitialized</a>, <a href="../AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../AbstractLifeCycle.html#setStarted()">setStarted</a>, <a href="../AbstractLifeCycle.html#setStarting()">setStarting</a>, <a href="../AbstractLifeCycle.html#setState(org.apache.logging.log4j.core.LifeCycle.State)">setState</a>, <a href="../AbstractLifeCycle.html#setStopped()">setStopped</a>, <a href="../AbstractLifeCycle.html#setStopping()">setStopping</a>, <a href="../AbstractLifeCycle.html#stop()">stop</a>, <a href="../AbstractLifeCycle.html#stop(java.util.concurrent.Future)">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.LifeCycle">Methods inherited from interface org.apache.logging.log4j.core.<a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></h3> |
| <code><a href="../LifeCycle.html#getState()">getState</a>, <a href="../LifeCycle.html#initialize()">initialize</a>, <a href="../LifeCycle.html#isStarted()">isStarted</a>, <a href="../LifeCycle.html#isStopped()">isStopped</a>, <a href="../LifeCycle.html#stop()">stop</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ROOT"> |
| <h3>ROOT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">ROOT</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.config.LoggerConfig.ROOT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>LoggerConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoggerConfig</span>()</div> |
| <div class="block">Default constructor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.logging.log4j.Level,boolean)"> |
| <h3>LoggerConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoggerConfig</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 additive)</span></div> |
| <div class="block">Constructor that sets the name, level and additive values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The Logger name.</dd> |
| <dd><code>level</code> - The Level.</dd> |
| <dd><code>additive</code> - true if the Logger is additive, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.util.List,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.Level,boolean,org.apache.logging.log4j.core.config.Property[],org.apache.logging.log4j.core.config.Configuration,boolean)"> |
| <h3>LoggerConfig</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">LoggerConfig</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>> appenders, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter, |
| <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 additive, |
| <a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| boolean includeLocation)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="newBuilder()"> |
| <h3>newBuilder</h3> |
| <div class="member-signature"><span class="annotations"><a href="plugins/PluginBuilderFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginBuilderFactory</a> |
| </span><span class="modifiers">public static</span> <span class="type-parameters"><B extends <a href="LoggerConfig.Builder.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.Builder</a><B>></span> <span class="return-type">B</span> <span class="element-name">newBuilder</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFilter()"> |
| <h3>getFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></span> <span class="element-name">getFilter</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../filter/AbstractFilterable.html#getFilter()">AbstractFilterable</a></code></span></div> |
| <div class="block">Returns the Filter.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../filter/Filterable.html#getFilter()">getFilter</a></code> in interface <code><a href="../filter/Filterable.html" title="interface in org.apache.logging.log4j.core.filter">Filterable</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../filter/AbstractFilterable.html#getFilter()">getFilter</a></code> in class <code><a href="../filter/AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the Filter or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>()</div> |
| <div class="block">Returns the name of the LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of the LoggerConfig.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParent(org.apache.logging.log4j.core.config.LoggerConfig)"> |
| <h3>setParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setParent</span><wbr><span class="parameters">(<a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a> parent)</span></div> |
| <div class="block">Sets the parent of this LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parent</code> - the parent LoggerConfig.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParent()"> |
| <h3>getParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></span> <span class="element-name">getParent</span>()</div> |
| <div class="block">Returns the parent of this LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the LoggerConfig that is the parent of this one.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAppender(org.apache.logging.log4j.core.Appender,org.apache.logging.log4j.Level,org.apache.logging.log4j.core.Filter)"> |
| <h3>addAppender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addAppender</span><wbr><span class="parameters">(<a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a> appender, |
| <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, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Adds an Appender to the LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>appender</code> - The Appender to add.</dd> |
| <dd><code>level</code> - The Level to use.</dd> |
| <dd><code>filter</code> - A Filter for the Appender reference.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAppender(java.lang.String)"> |
| <h3>removeAppender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeAppender</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">Removes the Appender with the specific name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the Appender.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppenders()"> |
| <h3>getAppenders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Appender.html" title="interface in org.apache.logging.log4j.core">Appender</a>></span> <span class="element-name">getAppenders</span>()</div> |
| <div class="block">Returns all Appenders as a Map.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a Map with the Appender name as the key and the Appender as the value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearAppenders()"> |
| <h3>clearAppenders</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">clearAppenders</span>()</div> |
| <div class="block">Removes all Appenders.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAppenderRefs()"> |
| <h3>getAppenderRefs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>></span> <span class="element-name">getAppenderRefs</span>()</div> |
| <div class="block">Returns the Appender references.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a List of all the Appender names attached to this LoggerConfig.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLevel(org.apache.logging.log4j.Level)"> |
| <h3>setLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLevel</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 logging Level.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - The logging Level.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLevel()"> |
| <h3>getLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getLevel</span>()</div> |
| <div class="block">Returns the logging Level.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the logging Level.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExplicitLevel()"> |
| <h3>getExplicitLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getExplicitLevel</span>()</div> |
| <div class="block">Allows callers to determine the Level assigned to this LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the Level associated with this LoggerConfig or null if none is set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLogEventFactory()"> |
| <h3>getLogEventFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../impl/LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a></span> <span class="element-name">getLogEventFactory</span>()</div> |
| <div class="block">Returns the LogEventFactory.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the LogEventFactory.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLogEventFactory(org.apache.logging.log4j.core.impl.LogEventFactory)"> |
| <h3>setLogEventFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLogEventFactory</span><wbr><span class="parameters">(<a href="../impl/LogEventFactory.html" title="interface in org.apache.logging.log4j.core.impl">LogEventFactory</a> logEventFactory)</span></div> |
| <div class="block">Sets the LogEventFactory. Usually the LogEventFactory will be this LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>logEventFactory</code> - the LogEventFactory.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAdditive()"> |
| <h3>isAdditive</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAdditive</span>()</div> |
| <div class="block">Returns the valid of the additive flag.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the LoggerConfig is additive, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAdditive(boolean)"> |
| <h3>setAdditive</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAdditive</span><wbr><span class="parameters">(boolean additive)</span></div> |
| <div class="block">Sets the additive setting.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>additive</code> - true if the LoggerConfig should be additive, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIncludeLocation()"> |
| <h3>isIncludeLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isIncludeLocation</span>()</div> |
| <div class="block">Returns the value of logger configuration attribute <code>includeLocation</code>, or, if no such attribute was |
| configured, <code>true</code> if logging is synchronous or <code>false</code> if logging is asynchronous.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether location should be passed downstream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperties()"> |
| <h3>getProperties</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">getProperties</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#getPropertyList()"><code>getPropertyList()</code></a> instead</div> |
| </div> |
| <div class="block">Returns an unmodifiable map with the configuration properties, or <code>null</code> if this <code>LoggerConfig</code> does |
| not have any configuration properties. |
| <p> |
| For each <code>Property</code> key in the map, the value is <code>true</code> if the property value has a variable that |
| needs to be substituted.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an unmodifiable map with the configuration properties, or <code>null</code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="Configuration.html#getStrSubstitutor()"><code>Configuration.getStrSubstitutor()</code></a></li> |
| <li><a href="../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>StrSubstitutor</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyList()"> |
| <h3>getPropertyList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>></span> <span class="element-name">getPropertyList</span>()</div> |
| <div class="block">Returns an unmodifiable list with the configuration properties, or <code>null</code> if this <code>LoggerConfig</code> does |
| not have any configuration properties. |
| <p> |
| Each <code>Property</code> in the list has an attribute <a href="Property.html#isValueNeedsLookup()"><code>valueNeedsLookup</code></a> that |
| is <code>true</code> if the property value has a variable that needs to be substituted.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an unmodifiable list with the configuration properties, or <code>null</code></dd> |
| <dt>Since:</dt> |
| <dd>2.7</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="Configuration.html#getStrSubstitutor()"><code>Configuration.getStrSubstitutor()</code></a></li> |
| <li><a href="../lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>StrSubstitutor</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isPropertiesRequireLookup()"> |
| <h3>isPropertiesRequireLookup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isPropertiesRequireLookup</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="log(java.lang.String,java.lang.String,org.apache.logging.log4j.Marker,org.apache.logging.log4j.Level,org.apache.logging.log4j.message.Message,java.lang.Throwable)"> |
| <h3>log</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">log</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> loggerName, |
| <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> fqcn, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">Message</a> data, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> t)</span></div> |
| <div class="block">Logs an event.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loggerName</code> - The name of the Logger.</dd> |
| <dd><code>fqcn</code> - The fully qualified class name of the caller.</dd> |
| <dd><code>marker</code> - A Marker or null if none is present.</dd> |
| <dd><code>level</code> - The event Level.</dd> |
| <dd><code>data</code> - The Message.</dd> |
| <dd><code>t</code> - A Throwable or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="log(java.lang.String,java.lang.String,java.lang.StackTraceElement,org.apache.logging.log4j.Marker,org.apache.logging.log4j.Level,org.apache.logging.log4j.message.Message,java.lang.Throwable)"> |
| <h3>log</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">log</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> loggerName, |
| <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> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html" title="class or interface in java.lang" class="external-link">StackTraceElement</a> location, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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, |
| <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">Message</a> data, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> t)</span></div> |
| <div class="block">Logs an event.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loggerName</code> - The name of the Logger.</dd> |
| <dd><code>fqcn</code> - The fully qualified class name of the caller.</dd> |
| <dd><code>location</code> - the location of the caller.</dd> |
| <dd><code>marker</code> - A Marker or null if none is present.</dd> |
| <dd><code>level</code> - The event Level.</dd> |
| <dd><code>data</code> - The Message.</dd> |
| <dd><code>t</code> - A Throwable or null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="log(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>log</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">log</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| <div class="block">Logs an event.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The log event.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="log(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.config.LoggerConfig.LoggerConfigPredicate)"> |
| <h3>log</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">log</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="LoggerConfig.LoggerConfigPredicate.html" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a> predicate)</span></div> |
| <div class="block">Logs an event.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The log event.</dd> |
| <dd><code>predicate</code> - predicate for which LoggerConfig instances to append to. A |
| null value is equivalent to a true predicate.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReliabilityStrategy()"> |
| <h3>getReliabilityStrategy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ReliabilityStrategy.html" title="interface in org.apache.logging.log4j.core.config">ReliabilityStrategy</a></span> <span class="element-name">getReliabilityStrategy</span>()</div> |
| <div class="block">Returns the object responsible for ensuring log events are delivered to a working appender, even during or after |
| a reconfiguration.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the object responsible for delivery of log events to the appender</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="processLogEvent(org.apache.logging.log4j.core.LogEvent,org.apache.logging.log4j.core.config.LoggerConfig.LoggerConfigPredicate)"> |
| <h3>processLogEvent</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">processLogEvent</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="LoggerConfig.LoggerConfigPredicate.html" title="enum in org.apache.logging.log4j.core.config">LoggerConfig.LoggerConfigPredicate</a> predicate)</span></div> |
| <div class="block">Logs an event, bypassing filters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The log event.</dd> |
| <dd><code>predicate</code> - predicate for which LoggerConfig instances to append to. A |
| null value is equivalent to a true predicate.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="requiresLocation()"> |
| <h3>requiresLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">requiresLocation</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../impl/LocationAware.html#requiresLocation()">requiresLocation</a></code> in interface <code><a href="../impl/LocationAware.html" title="interface in org.apache.logging.log4j.core.impl">LocationAware</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="callAppenders(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>callAppenders</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">callAppenders</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLogger(java.lang.String,org.apache.logging.log4j.Level,java.lang.String,java.lang.String,org.apache.logging.log4j.core.config.AppenderRef[],org.apache.logging.log4j.core.config.Property[],org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.Filter)"> |
| <h3>createLogger</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></span> <span class="element-name">createLogger</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> additivity, |
| <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, |
| <a href="plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</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> loggerName, |
| <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> includeLocation, |
| <a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] refs, |
| <a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties, |
| <a href="plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Deprecated in 2.7; use <a href="#createLogger(boolean,org.apache.logging.log4j.Level,java.lang.String,java.lang.String,org.apache.logging.log4j.core.config.AppenderRef%5B%5D,org.apache.logging.log4j.core.config.Property%5B%5D,org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.Filter)"><code>createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)</code></a></div> |
| </div> |
| <div class="block">Factory method to create a LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>additivity</code> - True if additive, false otherwise.</dd> |
| <dd><code>level</code> - The Level to be associated with the Logger.</dd> |
| <dd><code>loggerName</code> - The name of the Logger.</dd> |
| <dd><code>includeLocation</code> - whether location should be passed downstream</dd> |
| <dd><code>refs</code> - An array of Appender names.</dd> |
| <dd><code>properties</code> - Properties to pass to the Logger.</dd> |
| <dd><code>config</code> - The Configuration.</dd> |
| <dd><code>filter</code> - A Filter.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerConfig.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLogger(boolean,org.apache.logging.log4j.Level,java.lang.String,java.lang.String,org.apache.logging.log4j.core.config.AppenderRef[],org.apache.logging.log4j.core.config.Property[],org.apache.logging.log4j.core.config.Configuration,org.apache.logging.log4j.core.Filter)"> |
| <h3>createLogger</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></span> <span class="element-name">createLogger</span><wbr><span class="parameters">(<a href="plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>(<a href="plugins/PluginAttribute.html#value()">value</a>="additivity",<a href="plugins/PluginAttribute.html#defaultBoolean()">defaultBoolean</a>=true) |
| boolean additivity, |
| <a href="plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("level") |
| <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, |
| <a href="plugins/validation/constraints/Required.html" title="annotation in org.apache.logging.log4j.core.config.plugins.validation.constraints">@Required</a>(<a href="plugins/validation/constraints/Required.html#message()">message</a>="Loggers cannot be configured without a name") <a href="plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</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> loggerName, |
| <a href="plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("includeLocation") |
| <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> includeLocation, |
| <a href="plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("AppenderRef") |
| <a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] refs, |
| <a href="plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("Properties") |
| <a href="Property.html" title="class in org.apache.logging.log4j.core.config">Property</a>[] properties, |
| <a href="plugins/PluginConfiguration.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginConfiguration</a> |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config, |
| <a href="plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("Filter") |
| <a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Factory method to create a LoggerConfig.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>additivity</code> - true if additive, false otherwise.</dd> |
| <dd><code>level</code> - The Level to be associated with the Logger.</dd> |
| <dd><code>loggerName</code> - The name of the Logger.</dd> |
| <dd><code>includeLocation</code> - whether location should be passed downstream</dd> |
| <dd><code>refs</code> - An array of Appender names.</dd> |
| <dd><code>properties</code> - Properties to pass to the Logger.</dd> |
| <dd><code>config</code> - The Configuration.</dd> |
| <dd><code>filter</code> - A Filter.</dd> |
| <dt>Returns:</dt> |
| <dd>A new LoggerConfig.</dd> |
| <dt>Since:</dt> |
| <dd>2.6</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="includeLocation(java.lang.String)"> |
| <h3>includeLocation</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">boolean</span> <span class="element-name">includeLocation</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> includeLocationConfigValue)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="includeLocation(java.lang.String,org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>includeLocation</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">boolean</span> <span class="element-name">includeLocation</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> includeLocationConfigValue, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasAppenders()"> |
| <h3>hasAppenders</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">boolean</span> <span class="element-name">hasAppenders</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLevelAndRefs(org.apache.logging.log4j.Level,org.apache.logging.log4j.core.config.AppenderRef[],java.lang.String,org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>getLevelAndRefs</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="LoggerConfig.LevelAndRefs.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.LevelAndRefs</a></span> <span class="element-name">getLevelAndRefs</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, |
| <a href="AppenderRef.html" title="class in org.apache.logging.log4j.core.config">AppenderRef</a>[] refs, |
| <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> levelAndRefs, |
| <a href="Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> config)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |