| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StrSubstitutor (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.lookup, class: StrSubstitutor"> |
| <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/StrSubstitutor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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.lookup</a></div> |
| <h1 title="Class StrSubstitutor" class="title">Class StrSubstitutor</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">org.apache.logging.log4j.core.lookup.StrSubstitutor</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ConfigurationStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">ConfigurationStrSubstitutor</a></code>, <code><a href="RuntimeStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">RuntimeStrSubstitutor</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StrSubstitutor</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="../config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></span></div> |
| <div class="block">Substitutes variables within a string by values. |
| <p> |
| This class takes a piece of text and substitutes all the variables within it. |
| The default definition of a variable is <code>${variableName}</code>. |
| The prefix and suffix can be changed via constructors and set methods. |
| </p> |
| <p> |
| Variable values are typically resolved from a map, but could also be resolved |
| from system properties, or by supplying a custom variable resolver. |
| </p> |
| <p> |
| The simplest example is to use this class to replace Java System properties. For example: |
| </p> |
| <pre> |
| StrSubstitutor.replaceSystemProperties( |
| "You are running with java.version = ${java.version} and os.name = ${os.name}."); |
| </pre> |
| <p> |
| Typical usage of this class follows the following pattern: First an instance is created |
| and initialized with the map that contains the values for the available variables. |
| If a prefix and/or suffix for variables should be used other than the default ones, |
| the appropriate settings can be performed. After that the <code>replace()</code> |
| method can be called passing in the source text for interpolation. In the returned |
| text all variable references (as long as their values are known) will be resolved. |
| The following example demonstrates this: |
| </p> |
| <pre> |
| Map valuesMap = new HashMap<>(); |
| valuesMap.put("animal", "quick brown fox"); |
| valuesMap.put("target", "lazy dog"); |
| String templateString = "The ${animal} jumped over the ${target}."; |
| StrSubstitutor sub = new StrSubstitutor(valuesMap); |
| String resolvedString = sub.replace(templateString); |
| </pre> |
| <p>yielding:</p> |
| <pre> |
| The quick brown fox jumped over the lazy dog. |
| </pre> |
| <p> |
| Also, this class allows to set a default value for unresolved variables. |
| The default value for a variable can be appended to the variable name after the variable |
| default value delimiter. The default value of the variable default value delimiter is ':-', |
| as in bash and other *nix shells, as those are arguably where the default ${} delimiter set originated. |
| The variable default value delimiter can be manually set by calling <a href="#setValueDelimiterMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)"><code>setValueDelimiterMatcher(StrMatcher)</code></a>, |
| <a href="#setValueDelimiter(char)"><code>setValueDelimiter(char)</code></a> or <a href="#setValueDelimiter(java.lang.String)"><code>setValueDelimiter(String)</code></a>. |
| The following shows an example with variable default value settings: |
| </p> |
| <pre> |
| Map valuesMap = new HashMap<>(); |
| valuesMap.put("animal", "quick brown fox"); |
| valuesMap.put("target", "lazy dog"); |
| String templateString = "The ${animal} jumped over the ${target}. ${undefined.number:-1234567890}."; |
| StrSubstitutor sub = new StrSubstitutor(valuesMap); |
| String resolvedString = sub.replace(templateString); |
| </pre> |
| <p>yielding:</p> |
| <pre> |
| The quick brown fox jumped over the lazy dog. 1234567890. |
| </pre> |
| <p> |
| In addition to this usage pattern there are some static convenience methods that |
| cover the most common use cases. These methods can be used without the need of |
| manually creating an instance. However if multiple replace operations are to be |
| performed, creating and reusing an instance of this class will be more efficient. |
| </p> |
| <p> |
| Variable replacement works in a recursive way. Thus, if a variable value contains |
| a variable then that variable will also be replaced. Cyclic replacements are |
| detected and will cause an exception to be thrown. |
| </p> |
| <p> |
| Sometimes the interpolation's result must contain a variable prefix. As an example |
| take the following source text: |
| </p> |
| <pre> |
| The variable ${${name}} must be used. |
| </pre> |
| <p> |
| Here only the variable's name referred to in the text should be replaced resulting |
| in the text (assuming that the value of the <code>name</code> variable is <code>x</code>): |
| </p> |
| <pre> |
| The variable ${x} must be used. |
| </pre> |
| <p> |
| To achieve this effect there are two possibilities: Either set a different prefix |
| and suffix for variables which do not conflict with the result text you want to |
| produce. The other possibility is to use the escape character, by default '$'. |
| If this character is placed before a variable reference, this reference is ignored |
| and won't be replaced. For example: |
| </p> |
| <pre> |
| The variable $${${name}} must be used. |
| </pre> |
| <p> |
| In some complex scenarios you might even want to perform substitution in the |
| names of variables, for instance |
| </p> |
| <pre> |
| ${jre-${java.specification.version}} |
| </pre> |
| <p> |
| <code>StrSubstitutor</code> supports this recursive substitution in variable |
| names, but it has to be enabled explicitly by setting the |
| <a href="#setEnableSubstitutionInVariables(boolean)"><code>enableSubstitutionInVariables</code></a> |
| property to <b>true</b>. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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 char</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_ESCAPE" class="member-name-link">DEFAULT_ESCAPE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constant for the default escape character.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_PREFIX" class="member-name-link">DEFAULT_PREFIX</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constant for the default variable prefix.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_SUFFIX" class="member-name-link">DEFAULT_SUFFIX</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constant for the default variable suffix.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_VALUE_DELIMITER" class="member-name-link">DEFAULT_VALUE_DELIMITER</a></code></div> |
| <div class="col-last odd-row-color"> </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="#DEFAULT_VALUE_DELIMITER_STRING" class="member-name-link">DEFAULT_VALUE_DELIMITER_STRING</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constant for the default value delimiter of a variable.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_VALUE_ESCAPE_DELIMITER" class="member-name-link">DEFAULT_VALUE_ESCAPE_DELIMITER</a></code></div> |
| <div class="col-last odd-row-color"> </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="#ESCAPE_DELIMITER_STRING" class="member-name-link">ESCAPE_DELIMITER_STRING</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">StrSubstitutor</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance with defaults for variable prefix and suffix |
| and the escaping character.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.Map)" class="member-name-link">StrSubstitutor</a><wbr>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map,java.lang.String,java.lang.String)" class="member-name-link">StrSubstitutor</a><wbr>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.Map,java.lang.String,java.lang.String,char)" class="member-name-link">StrSubstitutor</a><wbr>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix, |
| char escape)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map,java.lang.String,java.lang.String,char,java.lang.String)" class="member-name-link">StrSubstitutor</a><wbr>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix, |
| char escape, |
| <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> valueDelimiter)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.Properties)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> properties)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup,java.lang.String,java.lang.String,char)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <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> prefix, |
| <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> suffix, |
| char escape)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup,java.lang.String,java.lang.String,char,java.lang.String)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <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> prefix, |
| <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> suffix, |
| char escape, |
| <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> valueDelimiter)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher,char)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher,char,org.apache.logging.log4j.core.lookup.StrMatcher)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher,char,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher)" class="member-name-link">StrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueEscapeMatcher)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new instance and initializes it.</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></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="#appendWithSeparators(java.lang.StringBuilder,java.lang.Iterable,java.lang.String)" class="member-name-link">appendWithSeparators</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><?> iterable, |
| <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> separator)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Appends a iterable placing separators between each value, but |
| not before the first or after the last.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEscapeChar()" class="member-name-link">getEscapeChar</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 escape character.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueDelimiterMatcher()" class="member-name-link">getValueDelimiterMatcher</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the variable default value delimiter matcher currently in use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVariablePrefixMatcher()" class="member-name-link">getVariablePrefixMatcher</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the variable prefix matcher currently in use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVariableResolver()" class="member-name-link">getVariableResolver</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the VariableResolver that is used to lookup variables.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVariableSuffixMatcher()" class="member-name-link">getVariableSuffixMatcher</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the variable suffix matcher currently in use.</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="#isEnableSubstitutionInVariables()" class="member-name-link">isEnableSubstitutionInVariables</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 a flag whether substitution is done in variable names.</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="#replace(char%5B%5D)" class="member-name-link">replace</a><wbr>(char[] source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template.</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="#replace(char%5B%5D,int,int)" class="member-name-link">replace</a><wbr>(char[] source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template.</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="#replace(java.lang.Object)" class="member-name-link">replace</a><wbr>(<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> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the resolver.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#replace(java.lang.Object,java.util.Map)" class="member-name-link">replace</a><wbr>(<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> source, |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#replace(java.lang.Object,java.util.Map,java.lang.String,java.lang.String)" class="member-name-link">replace</a><wbr>(<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> source, |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#replace(java.lang.Object,java.util.Properties)" class="member-name-link">replace</a><wbr>(<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> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> valueProperties)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables in the given source object with their matching |
| values from the properties.</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="#replace(java.lang.String)" class="member-name-link">replace</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> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template.</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="#replace(java.lang.StringBuffer)" class="member-name-link">replace</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template.</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="#replace(java.lang.StringBuffer,int,int)" class="member-name-link">replace</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template.</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="#replace(java.lang.StringBuilder)" class="member-name-link">replace</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template.</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="#replace(java.lang.StringBuilder,int,int)" class="member-name-link">replace</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template.</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="#replace(java.lang.String,int,int)" class="member-name-link">replace</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> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,char%5B%5D)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,char%5B%5D,int,int)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.Object)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the resolver.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.String)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer,int,int)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template.</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="#replace(org.apache.logging.log4j.core.LogEvent,java.lang.String,int,int)" class="member-name-link">replace</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template.</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="#replaceIn(java.lang.StringBuffer)" class="member-name-link">replaceIn</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver.</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="#replaceIn(java.lang.StringBuffer,int,int)" class="member-name-link">replaceIn</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver.</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="#replaceIn(java.lang.StringBuilder)" class="member-name-link">replaceIn</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</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="#replaceIn(java.lang.StringBuilder,int,int)" class="member-name-link">replaceIn</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</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="#replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer,int,int)" class="member-name-link">replaceIn</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver.</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="#replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)" class="member-name-link">replaceIn</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</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="#replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)" class="member-name-link">replaceIn</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="LookupResult.html" title="interface in org.apache.logging.log4j.core.lookup">LookupResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resolveVariable(org.apache.logging.log4j.core.LogEvent,java.lang.String,java.lang.StringBuilder,int,int)" class="member-name-link">resolveVariable</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> variableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf, |
| int startPos, |
| int endPos)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internal method that resolves the value of a variable.</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="#setConfiguration(org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">setConfiguration</a><wbr>(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Injects the current Configuration into this object.</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="#setEnableSubstitutionInVariables(boolean)" class="member-name-link">setEnableSubstitutionInVariables</a><wbr>(boolean enableSubstitutionInVariables)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a flag whether substitution is done in variable names.</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="#setEscapeChar(char)" class="member-name-link">setEscapeChar</a><wbr>(char escapeCharacter)</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 escape character.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValueDelimiter(char)" class="member-name-link">setValueDelimiter</a><wbr>(char valueDelimiter)</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 variable default value delimiter to use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValueDelimiter(java.lang.String)" class="member-name-link">setValueDelimiter</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> valueDelimiter)</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 variable default value delimiter to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValueDelimiterMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)" class="member-name-link">setValueDelimiterMatcher</a><wbr>(<a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</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 variable default value delimiter matcher to use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariablePrefix(char)" class="member-name-link">setVariablePrefix</a><wbr>(char prefix)</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 variable prefix to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariablePrefix(java.lang.String)" class="member-name-link">setVariablePrefix</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> prefix)</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 variable prefix to use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariablePrefixMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)" class="member-name-link">setVariablePrefixMatcher</a><wbr>(<a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher)</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 variable prefix matcher currently in use.</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="#setVariableResolver(org.apache.logging.log4j.core.lookup.StrLookup)" class="member-name-link">setVariableResolver</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</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 VariableResolver that is used to lookup variables.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariableSuffix(char)" class="member-name-link">setVariableSuffix</a><wbr>(char suffix)</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 variable suffix to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariableSuffix(java.lang.String)" class="member-name-link">setVariableSuffix</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> suffix)</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 variable suffix to use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariableSuffixMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)" class="member-name-link">setVariableSuffixMatcher</a><wbr>(<a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher)</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 variable suffix matcher currently in use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#substitute(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)" class="member-name-link">substitute</a><wbr>(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internal method that substitutes the variables.</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="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-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-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> |
| </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="DEFAULT_ESCAPE"> |
| <h3>DEFAULT_ESCAPE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">char</span> <span class="element-name">DEFAULT_ESCAPE</span></div> |
| <div class="block">Constant for the default escape character.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.lookup.StrSubstitutor.DEFAULT_ESCAPE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_PREFIX"> |
| <h3>DEFAULT_PREFIX</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">DEFAULT_PREFIX</span></div> |
| <div class="block">Constant for the default variable prefix.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SUFFIX"> |
| <h3>DEFAULT_SUFFIX</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">DEFAULT_SUFFIX</span></div> |
| <div class="block">Constant for the default variable suffix.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_VALUE_DELIMITER_STRING"> |
| <h3>DEFAULT_VALUE_DELIMITER_STRING</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">DEFAULT_VALUE_DELIMITER_STRING</span></div> |
| <div class="block">Constant for the default value delimiter of a variable.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.lookup.StrSubstitutor.DEFAULT_VALUE_DELIMITER_STRING">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_VALUE_DELIMITER"> |
| <h3>DEFAULT_VALUE_DELIMITER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">DEFAULT_VALUE_DELIMITER</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ESCAPE_DELIMITER_STRING"> |
| <h3>ESCAPE_DELIMITER_STRING</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">ESCAPE_DELIMITER_STRING</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.lookup.StrSubstitutor.ESCAPE_DELIMITER_STRING">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_VALUE_ESCAPE_DELIMITER"> |
| <h3>DEFAULT_VALUE_ESCAPE_DELIMITER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">DEFAULT_VALUE_ESCAPE_DELIMITER</span></div> |
| </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>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span>()</div> |
| <div class="block">Creates a new instance with defaults for variable prefix and suffix |
| and the escaping character.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.Map)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap)</span></div> |
| <div class="block">Creates a new instance and initializes it. Uses defaults for variable |
| prefix and suffix and the escaping character.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueMap</code> - the map with the variables' values, may be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.Map,java.lang.String,java.lang.String)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix)</span></div> |
| <div class="block">Creates a new instance and initializes it. Uses a default escaping character.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueMap</code> - the map with the variables' values, may be null</dd> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.Map,java.lang.String,java.lang.String,char)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix, |
| char escape)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueMap</code> - the map with the variables' values, may be null</dd> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.Map,java.lang.String,java.lang.String,char,java.lang.String)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix, |
| char escape, |
| <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> valueDelimiter)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueMap</code> - the map with the variables' values, may be null</dd> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dd><code>valueDelimiter</code> - the variable default value delimiter, may be null</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.Properties)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> properties)</span></div> |
| <div class="block">Creates a new instance and initializes it. Uses defaults for variable |
| prefix and suffix and the escaping character.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - the map with the variables' values, may be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.lookup.StrLookup)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.lookup.StrLookup,java.lang.String,java.lang.String,char)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <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> prefix, |
| <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> suffix, |
| char escape)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.lookup.StrLookup,java.lang.String,java.lang.String,char,java.lang.String)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <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> prefix, |
| <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> suffix, |
| char escape, |
| <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> valueDelimiter)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dd><code>valueDelimiter</code> - the variable default value delimiter string, may be null</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.lookup.StrLookup,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher,char)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| <dd><code>prefixMatcher</code> - the prefix for variables, not null</dd> |
| <dd><code>suffixMatcher</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.lookup.StrLookup,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher,char,org.apache.logging.log4j.core.lookup.StrMatcher)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| <dd><code>prefixMatcher</code> - the prefix for variables, not null</dd> |
| <dd><code>suffixMatcher</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dd><code>valueDelimiterMatcher</code> - the variable default value delimiter matcher, may be null</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.logging.log4j.core.lookup.StrLookup,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher,char,org.apache.logging.log4j.core.lookup.StrMatcher,org.apache.logging.log4j.core.lookup.StrMatcher)"> |
| <h3>StrSubstitutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher, |
| <a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueEscapeMatcher)</span></div> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| <dd><code>prefixMatcher</code> - the prefix for variables, not null</dd> |
| <dd><code>suffixMatcher</code> - the suffix for variables, not null</dd> |
| <dd><code>escape</code> - the escape character</dd> |
| <dd><code>valueDelimiterMatcher</code> - the variable default value delimiter matcher, may be null</dd> |
| <dd><code>valueEscapeMatcher</code> - the matcher to escape defaulting, may be null.</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </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="replace(java.lang.Object,java.util.Map)"> |
| <h3>replace</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">replace</span><wbr><span class="parameters">(<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> source, |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap)</span></div> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the source text containing the variables to substitute, null returns null</dd> |
| <dd><code>valueMap</code> - the map with the values, may be null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.Object,java.util.Map,java.lang.String,java.lang.String)"> |
| <h3>replace</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">replace</span><wbr><span class="parameters">(<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> source, |
| <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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> valueMap, |
| <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> prefix, |
| <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> suffix)</span></div> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map. This method allows to specify a |
| custom variable prefix and suffix</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the source text containing the variables to substitute, null returns null</dd> |
| <dd><code>valueMap</code> - the map with the values, may be null</dd> |
| <dd><code>prefix</code> - the prefix of variables, not null</dd> |
| <dd><code>suffix</code> - the suffix of variables, not null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix or suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.Object,java.util.Properties)"> |
| <h3>replace</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">replace</span><wbr><span class="parameters">(<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> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> valueProperties)</span></div> |
| <div class="block">Replaces all the occurrences of variables in the given source object with their matching |
| values from the properties.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the source text containing the variables to substitute, null returns null</dd> |
| <dd><code>valueProperties</code> - the properties with values, may be null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.String)"> |
| <h3>replace</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">replace</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> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the string to replace in, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.String)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The current LogEvent if there is one.</dd> |
| <dd><code>source</code> - the string to replace in, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.String,int,int)"> |
| <h3>replace</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">replace</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> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template. |
| <p> |
| Only the specified portion of the string will be processed. |
| The rest of the string is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the string to replace in, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.String,int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source string as a template. |
| <p> |
| Only the specified portion of the string will be processed. |
| The rest of the string is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the string to replace in, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(char[])"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(char[] source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template. |
| The array is not altered by this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the character array to replace in, not altered, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,char[])"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template. |
| The array is not altered by this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the character array to replace in, not altered, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(char[],int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(char[] source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template. |
| The array is not altered by this method. |
| <p> |
| Only the specified portion of the array will be processed. |
| The rest of the array is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the character array to replace in, not altered, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,char[],int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source array as a template. |
| The array is not altered by this method. |
| <p> |
| Only the specified portion of the array will be processed. |
| The rest of the array is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the character array to replace in, not altered, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.StringBuffer)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template. |
| The buffer is not altered by this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the buffer to use as a template, not changed, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template. |
| The buffer is not altered by this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the buffer to use as a template, not changed, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.StringBuffer,int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template. |
| The buffer is not altered by this method. |
| <p> |
| Only the specified portion of the buffer will be processed. |
| The rest of the buffer is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the buffer to use as a template, not changed, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer,int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source buffer as a template. |
| The buffer is not altered by this method. |
| <p> |
| Only the specified portion of the buffer will be processed. |
| The rest of the buffer is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the buffer to use as a template, not changed, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.StringBuilder)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template. |
| The builder is not altered by this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the builder to use as a template, not changed, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template. |
| The builder is not altered by this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The LogEvent.</dd> |
| <dd><code>source</code> - the builder to use as a template, not changed, null returns null.</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.StringBuilder,int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template. |
| The builder is not altered by this method. |
| <p> |
| Only the specified portion of the builder will be processed. |
| The rest of the builder is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the builder to use as a template, not changed, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables with their matching values |
| from the resolver using the given source builder as a template. |
| The builder is not altered by this method. |
| <p> |
| Only the specified portion of the builder will be processed. |
| The rest of the builder is not processed, and is not returned. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the builder to use as a template, not changed, null returns null</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the array to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(java.lang.Object)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<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> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the resolver. The input source object is |
| converted to a string using <code>toString</code> and is not altered.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the source to replace in, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replace(org.apache.logging.log4j.core.LogEvent,java.lang.Object)"> |
| <h3>replace</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">replace</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the resolver. The input source object is |
| converted to a string using <code>toString</code> and is not altered.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the source to replace in, null returns null</dd> |
| <dt>Returns:</dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(java.lang.StringBuffer)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver. |
| The buffer is updated with the result.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the buffer to replace in, updated, null returns false</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(java.lang.StringBuffer,int,int)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver. |
| The buffer is updated with the result. |
| <p> |
| Only the specified portion of the buffer will be processed. |
| The rest of the buffer is not processed, but it is not deleted. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the buffer to replace in, updated, null returns false</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the buffer to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer,int,int)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link">StringBuffer</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver. |
| The buffer is updated with the result. |
| <p> |
| Only the specified portion of the buffer will be processed. |
| The rest of the buffer is not processed, but it is not deleted. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the buffer to replace in, updated, null returns false</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the buffer to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(java.lang.StringBuilder)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the builder to replace in, updated, null returns false</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the builder to replace in, updated, null returns false</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(java.lang.StringBuilder,int,int)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver. |
| <p> |
| Only the specified portion of the builder will be processed. |
| The rest of the builder is not processed, but it is not deleted. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the builder to replace in, null returns false</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the builder to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)"> |
| <h3>replaceIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">replaceIn</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> source, |
| int offset, |
| int length)</span></div> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver. |
| <p> |
| Only the specified portion of the builder will be processed. |
| The rest of the builder is not processed, but it is not deleted. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the current LogEvent, if one is present.</dd> |
| <dd><code>source</code> - the builder to replace in, null returns false</dd> |
| <dd><code>offset</code> - the start offset within the array, must be valid</dd> |
| <dd><code>length</code> - the length within the builder to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="substitute(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)"> |
| <h3>substitute</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">substitute</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf, |
| int offset, |
| int length)</span></div> |
| <div class="block">Internal method that substitutes the variables. |
| <p> |
| Most users of this class do not need to call this method. This method will |
| be called automatically by another (public) method. |
| </p> |
| <p> |
| Writers of subclasses can override this method if they need access to |
| the substitution process at the start or end. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The current LogEvent, if there is one.</dd> |
| <dd><code>buf</code> - the string builder to substitute into, not null</dd> |
| <dd><code>offset</code> - the start offset within the builder, must be valid</dd> |
| <dd><code>length</code> - the length within the builder to be processed, must be valid</dd> |
| <dt>Returns:</dt> |
| <dd>true if altered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resolveVariable(org.apache.logging.log4j.core.LogEvent,java.lang.String,java.lang.StringBuilder,int,int)"> |
| <h3>resolveVariable</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="LookupResult.html" title="interface in org.apache.logging.log4j.core.lookup">LookupResult</a></span> <span class="element-name">resolveVariable</span><wbr><span class="parameters">(<a href="../LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| <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> variableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf, |
| int startPos, |
| int endPos)</span></div> |
| <div class="block">Internal method that resolves the value of a variable. |
| <p> |
| Most users of this class do not need to call this method. This method is |
| called automatically by the substitution process. |
| </p> |
| <p> |
| Writers of subclasses can override this method if they need to alter |
| how each substitution occurs. The method is passed the variable's name |
| and must return the corresponding value. This implementation uses the |
| <a href="#getVariableResolver()"><code>getVariableResolver()</code></a> with the variable's name as the key. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - The LogEvent, if there is one.</dd> |
| <dd><code>variableName</code> - the name of the variable, not null</dd> |
| <dd><code>buf</code> - the buffer where the substitution is occurring, not null</dd> |
| <dd><code>startPos</code> - the start position of the variable including the prefix, valid</dd> |
| <dd><code>endPos</code> - the end position of the variable including the suffix, valid</dd> |
| <dt>Returns:</dt> |
| <dd>the variable's value or <b>null</b> if the variable is unknown</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEscapeChar()"> |
| <h3>getEscapeChar</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">getEscapeChar</span>()</div> |
| <div class="block">Returns the escape character.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the character used for escaping variable references</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEscapeChar(char)"> |
| <h3>setEscapeChar</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEscapeChar</span><wbr><span class="parameters">(char escapeCharacter)</span></div> |
| <div class="block">Sets the escape character. |
| If this character is placed before a variable reference in the source |
| text, this variable will be ignored.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>escapeCharacter</code> - the escape character (0 for disabling escaping)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVariablePrefixMatcher()"> |
| <h3>getVariablePrefixMatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">getVariablePrefixMatcher</span>()</div> |
| <div class="block">Gets the variable prefix matcher currently in use. |
| <p> |
| The variable prefix is the character or characters that identify the |
| start of a variable. This prefix is expressed in terms of a matcher |
| allowing advanced prefix matches. |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the prefix matcher in use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariablePrefixMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)"> |
| <h3>setVariablePrefixMatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setVariablePrefixMatcher</span><wbr><span class="parameters">(<a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher)</span></div> |
| <div class="block">Sets the variable prefix matcher currently in use. |
| <p> |
| The variable prefix is the character or characters that identify the |
| start of a variable. This prefix is expressed in terms of a matcher |
| allowing advanced prefix matches. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>prefixMatcher</code> - the prefix matcher to use, must not be null</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix matcher is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariablePrefix(char)"> |
| <h3>setVariablePrefix</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setVariablePrefix</span><wbr><span class="parameters">(char prefix)</span></div> |
| <div class="block">Sets the variable prefix to use. |
| <p> |
| The variable prefix is the character or characters that identify the |
| start of a variable. This method allows a single character prefix to |
| be easily set. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>prefix</code> - the prefix character to use</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariablePrefix(java.lang.String)"> |
| <h3>setVariablePrefix</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setVariablePrefix</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> prefix)</span></div> |
| <div class="block">Sets the variable prefix to use. |
| <p> |
| The variable prefix is the character or characters that identify the |
| start of a variable. This method allows a string prefix to be easily set. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| <dt>Throws:</dt> |
| <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> - if the prefix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVariableSuffixMatcher()"> |
| <h3>getVariableSuffixMatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">getVariableSuffixMatcher</span>()</div> |
| <div class="block">Gets the variable suffix matcher currently in use. |
| <p> |
| The variable suffix is the character or characters that identify the |
| end of a variable. This suffix is expressed in terms of a matcher |
| allowing advanced suffix matches. |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the suffix matcher in use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariableSuffixMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)"> |
| <h3>setVariableSuffixMatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setVariableSuffixMatcher</span><wbr><span class="parameters">(<a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher)</span></div> |
| <div class="block">Sets the variable suffix matcher currently in use. |
| <p> |
| The variable suffix is the character or characters that identify the |
| end of a variable. This suffix is expressed in terms of a matcher |
| allowing advanced suffix matches. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>suffixMatcher</code> - the suffix matcher to use, must not be null</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| <dt>Throws:</dt> |
| <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> - if the suffix matcher is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariableSuffix(char)"> |
| <h3>setVariableSuffix</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setVariableSuffix</span><wbr><span class="parameters">(char suffix)</span></div> |
| <div class="block">Sets the variable suffix to use. |
| <p> |
| The variable suffix is the character or characters that identify the |
| end of a variable. This method allows a single character suffix to |
| be easily set. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>suffix</code> - the suffix character to use</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariableSuffix(java.lang.String)"> |
| <h3>setVariableSuffix</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setVariableSuffix</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> suffix)</span></div> |
| <div class="block">Sets the variable suffix to use. |
| <p> |
| The variable suffix is the character or characters that identify the |
| end of a variable. This method allows a string suffix to be easily set. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| <dt>Throws:</dt> |
| <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> - if the suffix is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueDelimiterMatcher()"> |
| <h3>getValueDelimiterMatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></span> <span class="element-name">getValueDelimiterMatcher</span>()</div> |
| <div class="block">Gets the variable default value delimiter matcher currently in use. |
| <p> |
| The variable default value delimiter is the character or characters that delimit the |
| variable name and the variable default value. This delimiter is expressed in terms of a matcher |
| allowing advanced variable default value delimiter matches. |
| </p> |
| <p> |
| If it returns null, then the variable default value resolution is disabled. |
| </p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the variable default value delimiter matcher in use, may be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setValueDelimiterMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)"> |
| <h3>setValueDelimiterMatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setValueDelimiterMatcher</span><wbr><span class="parameters">(<a href="StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</span></div> |
| <div class="block">Sets the variable default value delimiter matcher to use. |
| <p> |
| The variable default value delimiter is the character or characters that delimit the |
| variable name and the variable default value. This delimiter is expressed in terms of a matcher |
| allowing advanced variable default value delimiter matches. |
| </p> |
| <p> |
| If the <code>valueDelimiterMatcher</code> is null, then the variable default value resolution |
| becomes disabled. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueDelimiterMatcher</code> - variable default value delimiter matcher to use, may be null</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setValueDelimiter(char)"> |
| <h3>setValueDelimiter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setValueDelimiter</span><wbr><span class="parameters">(char valueDelimiter)</span></div> |
| <div class="block">Sets the variable default value delimiter to use. |
| <p> |
| The variable default value delimiter is the character or characters that delimit the |
| variable name and the variable default value. This method allows a single character |
| variable default value delimiter to be easily set. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueDelimiter</code> - the variable default value delimiter character to use</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setValueDelimiter(java.lang.String)"> |
| <h3>setValueDelimiter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span> <span class="element-name">setValueDelimiter</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> valueDelimiter)</span></div> |
| <div class="block">Sets the variable default value delimiter to use. |
| <p> |
| The variable default value delimiter is the character or characters that delimit the |
| variable name and the variable default value. This method allows a string |
| variable default value delimiter to be easily set. |
| </p> |
| <p> |
| If the <code>valueDelimiter</code> is null or empty string, then the variable default |
| value resolution becomes disabled. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueDelimiter</code> - the variable default value delimiter string to use, may be null or empty</dd> |
| <dt>Returns:</dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVariableResolver()"> |
| <h3>getVariableResolver</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a></span> <span class="element-name">getVariableResolver</span>()</div> |
| <div class="block">Gets the VariableResolver that is used to lookup variables.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the VariableResolver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariableResolver(org.apache.logging.log4j.core.lookup.StrLookup)"> |
| <h3>setVariableResolver</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setVariableResolver</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</span></div> |
| <div class="block">Sets the VariableResolver that is used to lookup variables.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>variableResolver</code> - the VariableResolver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEnableSubstitutionInVariables()"> |
| <h3>isEnableSubstitutionInVariables</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEnableSubstitutionInVariables</span>()</div> |
| <div class="block">Returns a flag whether substitution is done in variable names.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the substitution in variable names flag</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEnableSubstitutionInVariables(boolean)"> |
| <h3>setEnableSubstitutionInVariables</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEnableSubstitutionInVariables</span><wbr><span class="parameters">(boolean enableSubstitutionInVariables)</span></div> |
| <div class="block">Sets a flag whether substitution is done in variable names. If set to |
| <b>true</b>, the names of variables can contain other variables which are |
| processed first before the original variable is evaluated, e.g. |
| <code>${jre-${java.version}}</code>. The default value is <b>true</b>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enableSubstitutionInVariables</code> - the new value of the flag</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="appendWithSeparators(java.lang.StringBuilder,java.lang.Iterable,java.lang.String)"> |
| <h3>appendWithSeparators</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">appendWithSeparators</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><?> iterable, |
| <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> separator)</span></div> |
| <div class="block">Appends a iterable placing separators between each value, but |
| not before the first or after the last. |
| Appending a null iterable will have no effect..</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sb</code> - StringBuilder that contains the String being constructed.</dd> |
| <dd><code>iterable</code> - the iterable to append</dd> |
| <dd><code>separator</code> - the separator to use, null means no separator</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="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="setConfiguration(org.apache.logging.log4j.core.config.Configuration)"> |
| <h3>setConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConfiguration</span><wbr><span class="parameters">(<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../config/ConfigurationAware.html#setConfiguration(org.apache.logging.log4j.core.config.Configuration)">ConfigurationAware</a></code></span></div> |
| <div class="block">Injects the current Configuration into this object.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../config/ConfigurationAware.html#setConfiguration(org.apache.logging.log4j.core.config.Configuration)">setConfiguration</a></code> in interface <code><a href="../config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>configuration</code> - the current Configuration</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> |
