| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RegexFilter (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, class: RegexFilter"> |
| <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/RegexFilter.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>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="Class RegexFilter" class="title">Class RegexFilter</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="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilter</a> |
| <div class="inheritance">org.apache.logging.log4j.core.filter.RegexFilter</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</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> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../config/plugins/Plugin.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@Plugin</a>(<a href="../config/plugins/Plugin.html#name()">name</a>="RegexFilter", |
| <a href="../config/plugins/Plugin.html#category()">category</a>="Core", |
| <a href="../config/plugins/Plugin.html#elementType()">elementType</a>="filter", |
| <a href="../config/plugins/Plugin.html#printObject()">printObject</a>=true) |
| </span><span class="modifiers">public final class </span><span class="element-name type-name-label">RegexFilter</span> |
| <span class="extends-implements">extends <a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></span></div> |
| <div class="block">This filter returns the onMatch result if the message matches the regular expression. |
| |
| The "useRawMsg" attribute can be used to indicate whether the regular expression should be applied to the result of |
| calling Message.getMessageFormat (true) or Message.getFormattedMessage() (false). The default is false.</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.filter.AbstractFilter">Nested classes/interfaces inherited from class org.apache.logging.log4j.core.filter.<a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></h2> |
| <code><a href="AbstractFilter.AbstractFilterBuilder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter.AbstractFilterBuilder</a><<a href="AbstractFilter.AbstractFilterBuilder.html" title="type parameter in AbstractFilter.AbstractFilterBuilder">B</a> extends <a href="AbstractFilter.AbstractFilterBuilder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter.AbstractFilterBuilder</a><<a href="AbstractFilter.AbstractFilterBuilder.html" title="type parameter in AbstractFilter.AbstractFilterBuilder">B</a>>></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.core.Filter">Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></h2> |
| <code><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></code></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="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilter">Fields inherited from class org.apache.logging.log4j.core.filter.<a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></h3> |
| <code><a href="AbstractFilter.html#onMatch">onMatch</a>, <a href="AbstractFilter.html#onMismatch">onMismatch</a></code></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> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.Filter">Fields inherited from interface org.apache.logging.log4j.core.<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></h3> |
| <code><a href="../Filter.html#ELEMENT_TYPE">ELEMENT_TYPE</a>, <a href="../Filter.html#EMPTY_ARRAY">EMPTY_ARRAY</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-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></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-tab1 method-summary-table-tab4"><code>static <a href="RegexFilter.html" title="class in org.apache.logging.log4j.core.filter">RegexFilter</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFilter(java.lang.String,java.lang.String%5B%5D,java.lang.Boolean,org.apache.logging.log4j.core.Filter.Result,org.apache.logging.log4j.core.Filter.Result)" class="member-name-link">createFilter</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> regex, |
| <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>[] patternFlags, |
| <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> useRawMsg, |
| <a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> match, |
| <a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> mismatch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a Filter that matches a regular expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filter(org.apache.logging.log4j.core.LogEvent)" class="member-name-link">filter</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">Context Filter method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.Object,java.lang.Throwable)" class="member-name-link">filter</a><wbr>(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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> msg, |
| <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">Appender Filter method.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object...)" class="member-name-link">filter</a><wbr>(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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> msg, |
| <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>... params)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Appender Filter method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,org.apache.logging.log4j.message.Message,java.lang.Throwable)" class="member-name-link">filter</a><wbr>(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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/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/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">Message</a> msg, |
| <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">Appender Filter method.</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.AbstractFilter">Methods inherited from class org.apache.logging.log4j.core.filter.<a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></h3> |
| <code><a href="AbstractFilter.html#equalsImpl(java.lang.Object)">equalsImpl</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)">filter</a>, <a href="AbstractFilter.html#getOnMatch()">getOnMatch</a>, <a href="AbstractFilter.html#getOnMismatch()">getOnMismatch</a>, <a href="AbstractFilter.html#hashCodeImpl()">hashCodeImpl</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#getState()">getState</a>, <a href="../AbstractLifeCycle.html#getStatusLogger()">getStatusLogger</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#start()">start</a>, <a href="../AbstractLifeCycle.html#stop()">stop</a>, <a href="../AbstractLifeCycle.html#stop(long,java.util.concurrent.TimeUnit)">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.Filter">Methods inherited from interface org.apache.logging.log4j.core.<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></h3> |
| <code><a href="../Filter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String)">filter</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#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="filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object...)"> |
| <h3>filter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></span> <span class="element-name">filter</span><wbr><span class="parameters">(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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> msg, |
| <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>... params)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object...)">AbstractFilter</a></code></span></div> |
| <div class="block">Appender Filter method. The default returns NEUTRAL.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Filter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object...)">filter</a></code> in interface <code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.String,java.lang.Object...)">filter</a></code> in class <code><a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - the Logger.</dd> |
| <dd><code>level</code> - The logging Level.</dd> |
| <dd><code>marker</code> - The Marker, if any.</dd> |
| <dd><code>msg</code> - The message, if present.</dd> |
| <dd><code>params</code> - An array of parameters or null.</dd> |
| <dt>Returns:</dt> |
| <dd>The Result of filtering.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.Object,java.lang.Throwable)"> |
| <h3>filter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></span> <span class="element-name">filter</span><wbr><span class="parameters">(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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/Marker.html" title="class or interface in org.apache.logging.log4j" class="external-link">Marker</a> marker, |
| <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> msg, |
| <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"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.Object,java.lang.Throwable)">AbstractFilter</a></code></span></div> |
| <div class="block">Appender Filter method. The default returns NEUTRAL.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Filter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.Object,java.lang.Throwable)">filter</a></code> in interface <code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,java.lang.Object,java.lang.Throwable)">filter</a></code> in class <code><a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - the Logger.</dd> |
| <dd><code>level</code> - The logging Level.</dd> |
| <dd><code>marker</code> - The Marker, if any.</dd> |
| <dd><code>msg</code> - The message, if present.</dd> |
| <dd><code>t</code> - A throwable or null.</dd> |
| <dt>Returns:</dt> |
| <dd>The Result of filtering.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,org.apache.logging.log4j.message.Message,java.lang.Throwable)"> |
| <h3>filter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></span> <span class="element-name">filter</span><wbr><span class="parameters">(<a href="../Logger.html" title="class in org.apache.logging.log4j.core">Logger</a> logger, |
| <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/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/message/Message.html" title="class or interface in org.apache.logging.log4j.message" class="external-link">Message</a> msg, |
| <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"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,org.apache.logging.log4j.message.Message,java.lang.Throwable)">AbstractFilter</a></code></span></div> |
| <div class="block">Appender Filter method. The default returns NEUTRAL.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Filter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,org.apache.logging.log4j.message.Message,java.lang.Throwable)">filter</a></code> in interface <code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.Logger,org.apache.logging.log4j.Level,org.apache.logging.log4j.Marker,org.apache.logging.log4j.message.Message,java.lang.Throwable)">filter</a></code> in class <code><a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>logger</code> - the Logger.</dd> |
| <dd><code>level</code> - The logging Level.</dd> |
| <dd><code>marker</code> - The Marker, if any.</dd> |
| <dd><code>msg</code> - The message, if present.</dd> |
| <dd><code>t</code> - A throwable or null.</dd> |
| <dt>Returns:</dt> |
| <dd>The Result of filtering.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filter(org.apache.logging.log4j.core.LogEvent)"> |
| <h3>filter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a></span> <span class="element-name">filter</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"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.LogEvent)">AbstractFilter</a></code></span></div> |
| <div class="block">Context Filter method. The default returns NEUTRAL.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Filter.html#filter(org.apache.logging.log4j.core.LogEvent)">filter</a></code> in interface <code><a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractFilter.html#filter(org.apache.logging.log4j.core.LogEvent)">filter</a></code> in class <code><a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The LogEvent.</dd> |
| <dt>Returns:</dt> |
| <dd>The Result of filtering.</dd> |
| </dl> |
| </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="AbstractFilter.html#toString()">toString</a></code> in class <code><a href="AbstractFilter.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFilter(java.lang.String,java.lang.String[],java.lang.Boolean,org.apache.logging.log4j.core.Filter.Result,org.apache.logging.log4j.core.Filter.Result)"> |
| <h3>createFilter</h3> |
| <div class="member-signature"><span class="annotations"><a href="../config/plugins/PluginFactory.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginFactory</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="RegexFilter.html" title="class in org.apache.logging.log4j.core.filter">RegexFilter</a></span> <span class="element-name">createFilter</span><wbr><span class="parameters">(<a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("regex") |
| <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> regex, |
| <a href="../config/plugins/PluginElement.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginElement</a>("PatternFlags") |
| <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>[] patternFlags, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("useRawMsg") |
| <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> useRawMsg, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("onMatch") |
| <a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> match, |
| <a href="../config/plugins/PluginAttribute.html" title="annotation in org.apache.logging.log4j.core.config.plugins">@PluginAttribute</a>("onMismatch") |
| <a href="../Filter.Result.html" title="enum in org.apache.logging.log4j.core">Filter.Result</a> mismatch)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalAccessException.html" title="class or interface in java.lang" class="external-link">IllegalAccessException</a></span></div> |
| <div class="block">Creates a Filter that matches a regular expression.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regex</code> - The regular expression to match.</dd> |
| <dd><code>patternFlags</code> - An array of Strings where each String is a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html#compile-java.lang.String-int-" title="class or interface in java.util.regex" class="external-link"><code>Pattern.compile(String, int)</code></a> compilation flag.</dd> |
| <dd><code>useRawMsg</code> - If true, the raw message will be used, otherwise the formatted message will be used.</dd> |
| <dd><code>match</code> - The action to perform when a match occurs.</dd> |
| <dd><code>mismatch</code> - The action to perform when a mismatch occurs.</dd> |
| <dt>Returns:</dt> |
| <dd>The RegexFilter.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalAccessException.html" title="class or interface in java.lang" class="external-link">IllegalAccessException</a></code> - When there is no access to the definition of the specified member.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - When passed an illegal or inappropriate argument.</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> |
