| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:46 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StrSubstitutor (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StrSubstitutor (Apache Log4j Core 2.13.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9,"i20":9,"i21":9,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/lookup/StructuredDataLookup.html" title="class in org.apache.logging.log4j.core.lookup"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/lookup/StrSubstitutor.html" target="_top">Frames</a></li> |
| <li><a href="StrSubstitutor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.core.lookup</div> |
| <h2 title="Class StrSubstitutor" class="title">Class StrSubstitutor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.lookup.StrSubstitutor</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.141">StrSubstitutor</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></pre> |
| <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 = 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="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setValueDelimiterMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-"><code>setValueDelimiterMatcher(StrMatcher)</code></a>, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setValueDelimiter-char-"><code>setValueDelimiter(char)</code></a> or <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setValueDelimiter-java.lang.String-"><code>setValueDelimiter(String)</code></a>. |
| The following shows an example with variable default value settings: |
| </p> |
| <pre> |
| Map valuesMap = 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="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setEnableSubstitutionInVariables-boolean-"><code>enableSubstitutionInVariables</code></a> |
| property to <b>true</b>. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#DEFAULT_ESCAPE">DEFAULT_ESCAPE</a></span></code> |
| <div class="block">Constant for the default escape character.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#DEFAULT_PREFIX">DEFAULT_PREFIX</a></span></code> |
| <div class="block">Constant for the default variable prefix.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#DEFAULT_SUFFIX">DEFAULT_SUFFIX</a></span></code> |
| <div class="block">Constant for the default variable suffix.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#DEFAULT_VALUE_DELIMITER">DEFAULT_VALUE_DELIMITER</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#DEFAULT_VALUE_DELIMITER_STRING">DEFAULT_VALUE_DELIMITER_STRING</a></span></code> |
| <div class="block">Constant for the default value delimiter of a variable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#DEFAULT_VALUE_ESCAPE_DELIMITER">DEFAULT_VALUE_ESCAPE_DELIMITER</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#ESCAPE_DELIMITER_STRING">ESCAPE_DELIMITER_STRING</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor--">StrSubstitutor</a></span>()</code> |
| <div class="block">Creates a new instance with defaults for variable prefix and suffix |
| and the escaping character.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-java.util.Map-">StrSubstitutor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-java.util.Map-java.lang.String-java.lang.String-">StrSubstitutor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-java.util.Map-java.lang.String-java.lang.String-char-">StrSubstitutor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-java.util.Map-java.lang.String-java.lang.String-char-java.lang.String-">StrSubstitutor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueDelimiter)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-java.util.Properties-">StrSubstitutor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-">StrSubstitutor</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-java.lang.String-java.lang.String-char-">StrSubstitutor</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/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?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-java.lang.String-java.lang.String-char-java.lang.String-">StrSubstitutor</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/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?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueDelimiter)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-org.apache.logging.log4j.core.lookup.StrMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-char-">StrSubstitutor</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-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-">StrSubstitutor</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#StrSubstitutor-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-">StrSubstitutor</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueEscapeMatcher)</code> |
| <div class="block">Creates a new instance and initializes it.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#appendWithSeparators-java.lang.StringBuilder-java.lang.Iterable-java.lang.String-">appendWithSeparators</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> sb, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> iterable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</code> |
| <div class="block">Appends a iterable placing separators between each value, but |
| not before the first or after the last.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#getEscapeChar--">getEscapeChar</a></span>()</code> |
| <div class="block">Returns the escape character.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#getValueDelimiterMatcher--">getValueDelimiterMatcher</a></span>()</code> |
| <div class="block">Gets the variable default value delimiter matcher currently in use.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#getVariablePrefixMatcher--">getVariablePrefixMatcher</a></span>()</code> |
| <div class="block">Gets the variable prefix matcher currently in use.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#getVariableResolver--">getVariableResolver</a></span>()</code> |
| <div class="block">Gets the VariableResolver that is used to lookup variables.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#getVariableSuffixMatcher--">getVariableSuffixMatcher</a></span>()</code> |
| <div class="block">Gets the variable suffix matcher currently in use.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#isEnableSubstitutionInVariables--">isEnableSubstitutionInVariables</a></span>()</code> |
| <div class="block">Returns a flag whether substitution is done in variable names.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-char:A-">replace</a></span>(char[] source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-char:A-int-int-">replace</a></span>(char[] source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-char:A-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-char:A-int-int-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.Object-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">Object</a> source)</code> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.String-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">String</a> source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuffer-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuffer</a> source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuffer-int-int-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-int-int-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-org.apache.logging.log4j.core.LogEvent-java.lang.String-int-int-">replace</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">String</a> source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.Object-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source)</code> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.Object-java.util.Map-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap)</code> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.Object-java.util.Map-java.lang.String-java.lang.String-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix)</code> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.Object-java.util.Properties-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> valueProperties)</code> |
| <div class="block">Replaces all the occurrences of variables in the given source object with their matching |
| values from the properties.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.String-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.StringBuffer-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.StringBuffer-int-int-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.StringBuilder-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.StringBuilder-int-int-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replace-java.lang.String-int-int-">replace</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source, |
| int offset, |
| int length)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuffer-int-int-">replaceIn</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-">replaceIn</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-int-int-">replaceIn</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-java.lang.StringBuffer-">replaceIn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-java.lang.StringBuffer-int-int-">replaceIn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source buffer |
| with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-java.lang.StringBuilder-">replaceIn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#replaceIn-java.lang.StringBuilder-int-int-">replaceIn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</code> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#resolveVariable-org.apache.logging.log4j.core.LogEvent-java.lang.String-java.lang.StringBuilder-int-int-">resolveVariable</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">String</a> variableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> buf, |
| int startPos, |
| int endPos)</code> |
| <div class="block">Internal method that resolves the value of a variable.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setConfiguration-org.apache.logging.log4j.core.config.Configuration-">setConfiguration</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</code> |
| <div class="block">Injects the current Configuration into this object.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setEnableSubstitutionInVariables-boolean-">setEnableSubstitutionInVariables</a></span>(boolean enableSubstitutionInVariables)</code> |
| <div class="block">Sets a flag whether substitution is done in variable names.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setEscapeChar-char-">setEscapeChar</a></span>(char escapeCharacter)</code> |
| <div class="block">Sets the escape character.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setValueDelimiter-char-">setValueDelimiter</a></span>(char valueDelimiter)</code> |
| <div class="block">Sets the variable default value delimiter to use.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setValueDelimiter-java.lang.String-">setValueDelimiter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueDelimiter)</code> |
| <div class="block">Sets the variable default value delimiter to use.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setValueDelimiterMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-">setValueDelimiterMatcher</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</code> |
| <div class="block">Sets the variable default value delimiter matcher to use.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariablePrefix-char-">setVariablePrefix</a></span>(char prefix)</code> |
| <div class="block">Sets the variable prefix to use.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariablePrefix-java.lang.String-">setVariablePrefix</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</code> |
| <div class="block">Sets the variable prefix to use.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariablePrefixMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-">setVariablePrefixMatcher</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher)</code> |
| <div class="block">Sets the variable prefix matcher currently in use.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariableResolver-org.apache.logging.log4j.core.lookup.StrLookup-">setVariableResolver</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</code> |
| <div class="block">Sets the VariableResolver that is used to lookup variables.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariableSuffix-char-">setVariableSuffix</a></span>(char suffix)</code> |
| <div class="block">Sets the variable suffix to use.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariableSuffix-java.lang.String-">setVariableSuffix</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix)</code> |
| <div class="block">Sets the variable suffix to use.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#setVariableSuffixMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-">setVariableSuffixMatcher</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher)</code> |
| <div class="block">Sets the variable suffix matcher currently in use.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#substitute-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-int-int-">substitute</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> buf, |
| int offset, |
| int length)</code> |
| <div class="block">Internal method that substitutes the variables.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_ESCAPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ESCAPE</h4> |
| <pre>public static final char <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.146">DEFAULT_ESCAPE</a></pre> |
| <div class="block">Constant for the default escape character.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.lookup.StrSubstitutor.DEFAULT_ESCAPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PREFIX</h4> |
| <pre>public static final <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.151">DEFAULT_PREFIX</a></pre> |
| <div class="block">Constant for the default variable prefix.</div> |
| </li> |
| </ul> |
| <a name="DEFAULT_SUFFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SUFFIX</h4> |
| <pre>public static final <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.156">DEFAULT_SUFFIX</a></pre> |
| <div class="block">Constant for the default variable suffix.</div> |
| </li> |
| </ul> |
| <a name="DEFAULT_VALUE_DELIMITER_STRING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_VALUE_DELIMITER_STRING</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.161">DEFAULT_VALUE_DELIMITER_STRING</a></pre> |
| <div class="block">Constant for the default value delimiter of a variable.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.lookup.StrSubstitutor.DEFAULT_VALUE_DELIMITER_STRING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_VALUE_DELIMITER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_VALUE_DELIMITER</h4> |
| <pre>public static final <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.162">DEFAULT_VALUE_DELIMITER</a></pre> |
| </li> |
| </ul> |
| <a name="ESCAPE_DELIMITER_STRING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ESCAPE_DELIMITER_STRING</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.164">ESCAPE_DELIMITER_STRING</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.logging.log4j.core.lookup.StrSubstitutor.ESCAPE_DELIMITER_STRING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_VALUE_ESCAPE_DELIMITER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_VALUE_ESCAPE_DELIMITER</h4> |
| <pre>public static final <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.165">DEFAULT_VALUE_ESCAPE_DELIMITER</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="StrSubstitutor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.215">StrSubstitutor</a>()</pre> |
| <div class="block">Creates a new instance with defaults for variable prefix and suffix |
| and the escaping character.</div> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.225">StrSubstitutor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap)</pre> |
| <div class="block">Creates a new instance and initializes it. Uses defaults for variable |
| prefix and suffix and the escaping character.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueMap</code> - the map with the variables' values, may be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-java.util.Map-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.237">StrSubstitutor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix)</pre> |
| <div class="block">Creates a new instance and initializes it. Uses a default escaping character.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-java.util.Map-java.lang.String-java.lang.String-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.250">StrSubstitutor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-java.util.Map-java.lang.String-java.lang.String-char-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.265">StrSubstitutor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueDelimiter)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.276">StrSubstitutor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</pre> |
| <div class="block">Creates a new instance and initializes it. Uses defaults for variable |
| prefix and suffix and the escaping character.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - the map with the variables' values, may be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.285">StrSubstitutor</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>variableResolver</code> - the variable resolver, may be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-java.lang.String-java.lang.String-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.298">StrSubstitutor</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/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?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-java.lang.String-java.lang.String-char-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.316">StrSubstitutor</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/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?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix, |
| char escape, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueDelimiter)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-org.apache.logging.log4j.core.lookup.StrLookup-org.apache.logging.log4j.core.lookup.StrMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.333">StrSubstitutor</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-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-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.351">StrSubstitutor</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="StrSubstitutor-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-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StrSubstitutor</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.371">StrSubstitutor</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher, |
| char escape, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher, |
| <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueEscapeMatcher)</pre> |
| <div class="block">Creates a new instance and initializes it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="replace-java.lang.Object-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.391">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap)</pre> |
| <div class="block">Replaces all the occurrences of variables in the given source object with |
| their matching values from the map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.Object-java.util.Map-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.407">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> valueMap, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix or suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.Object-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.420">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> valueProperties)</pre> |
| <div class="block">Replaces all the occurrences of variables in the given source object with their matching |
| values from the properties.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.450">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the string to replace in, null returns null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.462">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">String</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.String-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.486">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.String-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.504">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">String</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-char:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.524">replace</a>(char[] source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the character array to replace in, not altered, null returns null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-char:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.538">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.561">replace</a>(char[] source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-char:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.580">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html" title="interface in org.apache.logging.log4j.core">LogEvent</a> event, |
| char[] source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.StringBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.598">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the buffer to use as a template, not changed, null returns null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.612">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuffer</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.StringBuffer-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.635">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuffer-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.654">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.672">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the builder to use as a template, not changed, null returns null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.686">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.StringBuilder-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.708">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.727">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.745">replace</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the source to replace in, null returns null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replace-org.apache.logging.log4j.core.LogEvent-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replace</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.758">replace</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">Object</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of the replace operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-java.lang.StringBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.776">replaceIn</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the buffer to replace in, updated, null returns zero</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-java.lang.StringBuffer-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.797">replaceIn</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the buffer to replace in, updated, null returns zero</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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuffer-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.816">replaceIn</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuffer</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the buffer to replace in, updated, null returns zero</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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.836">replaceIn</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</pre> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the builder to replace in, updated, null returns zero</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.849">replaceIn</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source)</pre> |
| <div class="block">Replaces all the occurrences of variables within the given source |
| builder with their matching values from the resolver.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the current LogEvent, if one exists.</dd> |
| <dd><code>source</code> - the builder to replace in, updated, null returns zero</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-java.lang.StringBuilder-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.868">replaceIn</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the builder to replace in, null returns zero</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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceIn-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceIn</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.886">replaceIn</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> source, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the current LogEvent, if one is present.</dd> |
| <dd><code>source</code> - the builder to replace in, null returns zero</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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="substitute-org.apache.logging.log4j.core.LogEvent-java.lang.StringBuilder-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>substitute</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.911">substitute</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">StringBuilder</a> buf, |
| int offset, |
| int length)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if altered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveVariable-org.apache.logging.log4j.core.LogEvent-java.lang.String-java.lang.StringBuilder-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveVariable</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1110">resolveVariable</a>(<a href="../../../../../../org/apache/logging/log4j/core/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?is-external=true" title="class or interface in java.lang">String</a> variableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> buf, |
| int startPos, |
| int endPos)</pre> |
| <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="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html#getVariableResolver--"><code>getVariableResolver()</code></a> with the variable's name as the key. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>the variable's value or <b>null</b> if the variable is unknown</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEscapeChar--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEscapeChar</h4> |
| <pre>public char <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1126">getEscapeChar</a>()</pre> |
| <div class="block">Returns the escape character.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the character used for escaping variable references</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEscapeChar-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEscapeChar</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1137">setEscapeChar</a>(char escapeCharacter)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>escapeCharacter</code> - the escape character (0 for disabling escaping)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVariablePrefixMatcher--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVariablePrefixMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1153">getVariablePrefixMatcher</a>()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the prefix matcher in use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariablePrefixMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariablePrefixMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1169">setVariablePrefixMatcher</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> prefixMatcher)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefixMatcher</code> - the prefix matcher to use, null ignored</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix matcher is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariablePrefix-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariablePrefix</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1188">setVariablePrefix</a>(char prefix)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - the prefix character to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariablePrefix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariablePrefix</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1203">setVariablePrefix</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - the prefix for variables, not null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the prefix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVariableSuffixMatcher--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVariableSuffixMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1222">getVariableSuffixMatcher</a>()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the suffix matcher in use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariableSuffixMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariableSuffixMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1238">setVariableSuffixMatcher</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> suffixMatcher)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>suffixMatcher</code> - the suffix matcher to use, null ignored</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the suffix matcher is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariableSuffix-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariableSuffix</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1257">setVariableSuffix</a>(char suffix)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>suffix</code> - the suffix character to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariableSuffix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariableSuffix</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1272">setVariableSuffix</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> suffix)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>suffix</code> - the suffix for variables, not null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the suffix is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueDelimiterMatcher--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueDelimiterMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1294">getValueDelimiterMatcher</a>()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the variable default value delimiter matcher in use, may be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueDelimiterMatcher-org.apache.logging.log4j.core.lookup.StrMatcher-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueDelimiterMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1313">setValueDelimiterMatcher</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup">StrMatcher</a> valueDelimiterMatcher)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueDelimiterMatcher</code> - variable default value delimiter matcher to use, may be null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueDelimiter-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueDelimiter</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1329">setValueDelimiter</a>(char valueDelimiter)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueDelimiter</code> - the variable default value delimiter character to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueDelimiter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueDelimiter</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1348">setValueDelimiter</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueDelimiter)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueDelimiter</code> - the variable default value delimiter string to use, may be null or empty</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this, to enable chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVariableResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVariableResolver</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1366">getVariableResolver</a>()</pre> |
| <div class="block">Gets the VariableResolver that is used to lookup variables.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the VariableResolver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariableResolver-org.apache.logging.log4j.core.lookup.StrLookup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariableResolver</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1375">setVariableResolver</a>(<a href="../../../../../../org/apache/logging/log4j/core/lookup/StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a> variableResolver)</pre> |
| <div class="block">Sets the VariableResolver that is used to lookup variables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>variableResolver</code> - the VariableResolver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEnableSubstitutionInVariables--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnableSubstitutionInVariables</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1389">isEnableSubstitutionInVariables</a>()</pre> |
| <div class="block">Returns a flag whether substitution is done in variable names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the substitution in variable names flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEnableSubstitutionInVariables-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnableSubstitutionInVariables</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1401">setEnableSubstitutionInVariables</a>(boolean enableSubstitutionInVariables)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enableSubstitutionInVariables</code> - the new value of the flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="appendWithSeparators-java.lang.StringBuilder-java.lang.Iterable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendWithSeparators</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1420">appendWithSeparators</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> sb, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><?> iterable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1434">toString</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfiguration-org.apache.logging.log4j.core.config.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setConfiguration</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/lookup/StrSubstitutor.html#line.1439">setConfiguration</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a> configuration)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationAware.html#setConfiguration-org.apache.logging.log4j.core.config.Configuration-">setConfiguration</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configuration</code> - the current Configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/lookup/StrMatcher.html" title="class in org.apache.logging.log4j.core.lookup"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/lookup/StructuredDataLookup.html" title="class in org.apache.logging.log4j.core.lookup"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/lookup/StrSubstitutor.html" target="_top">Frames</a></li> |
| <li><a href="StrSubstitutor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2020 <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> |
| </body> |
| </html> |