| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Filterable (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.filter, interface: Filterable"> |
| <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/Filterable.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.filter</a></div> |
| <h1 title="Interface Filterable" class="title">Interface Filterable</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../appender/AbstractAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender</a></code>, <code><a href="../config/AbstractConfiguration.html" title="class in org.apache.logging.log4j.core.config">AbstractConfiguration</a></code>, <code><a href="../appender/db/AbstractDatabaseAppender.html" title="class in org.apache.logging.log4j.core.appender.db">AbstractDatabaseAppender</a></code>, <code><a href="../appender/AbstractFileAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractFileAppender</a></code>, <code><a href="AbstractFilterable.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable</a></code>, <code><a href="../appender/AbstractOutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractOutputStreamAppender</a></code>, <code><a href="../appender/AbstractWriterAppender.html" title="class in org.apache.logging.log4j.core.appender">AbstractWriterAppender</a></code>, <code><a href="../config/AppenderControl.html" title="class in org.apache.logging.log4j.core.config">AppenderControl</a></code>, <code><a href="../appender/AsyncAppender.html" title="class in org.apache.logging.log4j.core.appender">AsyncAppender</a></code>, <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="../config/builder/impl/BuiltConfiguration.html" title="class in org.apache.logging.log4j.core.config.builder.impl">BuiltConfiguration</a></code>, <code><a href="../config/composite/CompositeConfiguration.html" title="class in org.apache.logging.log4j.core.config.composite">CompositeConfiguration</a></code>, <code><a href="../appender/ConsoleAppender.html" title="class in org.apache.logging.log4j.core.appender">ConsoleAppender</a></code>, <code><a href="../appender/CountingNoOpAppender.html" title="class in org.apache.logging.log4j.core.appender">CountingNoOpAppender</a></code>, <code><a href="../config/DefaultConfiguration.html" title="class in org.apache.logging.log4j.core.config">DefaultConfiguration</a></code>, <code><a href="../appender/FailoverAppender.html" title="class in org.apache.logging.log4j.core.appender">FailoverAppender</a></code>, <code><a href="../appender/FileAppender.html" title="class in org.apache.logging.log4j.core.appender">FileAppender</a></code>, <code><a href="../appender/HttpAppender.html" title="class in org.apache.logging.log4j.core.appender">HttpAppender</a></code>, <code><a href="../appender/db/jdbc/JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender</a></code>, <code><a href="../appender/mom/jeromq/JeroMqAppender.html" title="class in org.apache.logging.log4j.core.appender.mom.jeromq">JeroMqAppender</a></code>, <code><a href="../appender/mom/JmsAppender.html" title="class in org.apache.logging.log4j.core.appender.mom">JmsAppender</a></code>, <code><a href="../config/json/JsonConfiguration.html" title="class in org.apache.logging.log4j.core.config.json">JsonConfiguration</a></code>, <code><a href="../appender/mom/kafka/KafkaAppender.html" title="class in org.apache.logging.log4j.core.appender.mom.kafka">KafkaAppender</a></code>, <code><a href="../config/LoggerConfig.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig</a></code>, <code><a href="../config/LoggerConfig.RootLogger.html" title="class in org.apache.logging.log4j.core.config">LoggerConfig.RootLogger</a></code>, <code><a href="../appender/MemoryMappedFileAppender.html" title="class in org.apache.logging.log4j.core.appender">MemoryMappedFileAppender</a></code>, <code><a href="../appender/nosql/NoSqlAppender.html" title="class in org.apache.logging.log4j.core.appender.nosql">NoSqlAppender</a></code>, <code><a href="../appender/NullAppender.html" title="class in org.apache.logging.log4j.core.appender">NullAppender</a></code>, <code><a href="../config/NullConfiguration.html" title="class in org.apache.logging.log4j.core.config">NullConfiguration</a></code>, <code><a href="../appender/OutputStreamAppender.html" title="class in org.apache.logging.log4j.core.appender">OutputStreamAppender</a></code>, <code><a href="../config/properties/PropertiesConfiguration.html" title="class in org.apache.logging.log4j.core.config.properties">PropertiesConfiguration</a></code>, <code><a href="../appender/RandomAccessFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RandomAccessFileAppender</a></code>, <code><a href="../appender/rewrite/RewriteAppender.html" title="class in org.apache.logging.log4j.core.appender.rewrite">RewriteAppender</a></code>, <code><a href="../appender/RollingFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RollingFileAppender</a></code>, <code><a href="../appender/RollingRandomAccessFileAppender.html" title="class in org.apache.logging.log4j.core.appender">RollingRandomAccessFileAppender</a></code>, <code><a href="../appender/routing/RoutingAppender.html" title="class in org.apache.logging.log4j.core.appender.routing">RoutingAppender</a></code>, <code><a href="../appender/ScriptAppenderSelector.html" title="class in org.apache.logging.log4j.core.appender">ScriptAppenderSelector</a></code>, <code><a href="../appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></code>, <code><a href="../appender/SocketAppender.html" title="class in org.apache.logging.log4j.core.appender">SocketAppender</a></code>, <code><a href="../appender/SyslogAppender.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender</a></code>, <code><a href="../appender/WriterAppender.html" title="class in org.apache.logging.log4j.core.appender">WriterAppender</a></code>, <code><a href="../config/xml/XmlConfiguration.html" title="class in org.apache.logging.log4j.core.config.xml">XmlConfiguration</a></code>, <code><a href="../config/yaml/YamlConfiguration.html" title="class in org.apache.logging.log4j.core.config.yaml">YamlConfiguration</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Filterable</span><span class="extends-implements"> |
| extends <a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core">LifeCycle</a></span></div> |
| <div class="block">Interface implemented by Classes that allow filtering to occur. |
| |
| <p> |
| Extends <a href="../LifeCycle.html" title="interface in org.apache.logging.log4j.core"><code>LifeCycle</code></a> since filters have a life cycle. |
| </p></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="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> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addFilter(org.apache.logging.log4j.core.Filter)" class="member-name-link">addFilter</a><wbr>(<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-tab3"> |
| <div class="block">Adds a new Filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFilter()" class="member-name-link">getFilter</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns an Iterator for all the Filters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasFilter()" class="member-name-link">hasFilter</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Determine if a Filter is present.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isFiltered(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">isFiltered</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-tab3"> |
| <div class="block">Determines if the event should be filtered.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeFilter(org.apache.logging.log4j.core.Filter)" class="member-name-link">removeFilter</a><wbr>(<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-tab3"> |
| <div class="block">Removes a Filter.</div> |
| </div> |
| </div> |
| </div> |
| </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#start()">start</a>, <a href="../LifeCycle.html#stop()">stop</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addFilter(org.apache.logging.log4j.core.Filter)"> |
| <h3>addFilter</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addFilter</span><wbr><span class="parameters">(<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Adds a new Filter. If a Filter already exists it is converted to a CompositeFilter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - The Filter to add.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeFilter(org.apache.logging.log4j.core.Filter)"> |
| <h3>removeFilter</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeFilter</span><wbr><span class="parameters">(<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Removes a Filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - The Filter to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFilter()"> |
| <h3>getFilter</h3> |
| <div class="member-signature"><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">Returns an Iterator for all the Filters.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an Iterator for all the Filters.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasFilter()"> |
| <h3>hasFilter</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasFilter</span>()</div> |
| <div class="block">Determine if a Filter is present.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if a Filter is present, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFiltered(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>isFiltered</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isFiltered</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">Determines if the event should be filtered.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The LogEvent.</dd> |
| <dt>Returns:</dt> |
| <dd>true if the event should be filtered, false otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
