blob: 61270460682d4ff1ac6dc2a6909756746ab502e7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RuntimeStrSubstitutor (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.logging.log4j.core.lookup, class: RuntimeStrSubstitutor">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/RuntimeStrSubstitutor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.lookup</a></div>
<h1 title="Class RuntimeStrSubstitutor" class="title">Class RuntimeStrSubstitutor</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">org.apache.logging.log4j.core.lookup.StrSubstitutor</a>
<div class="inheritance">org.apache.logging.log4j.core.lookup.RuntimeStrSubstitutor</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../config/ConfigurationAware.html" title="interface in org.apache.logging.log4j.core.config">ConfigurationAware</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">RuntimeStrSubstitutor</span>
<span class="extends-implements">extends <a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></span></div>
<div class="block"><a href="RuntimeStrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>RuntimeStrSubstitutor</code></a> is a <a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup"><code>StrSubstitutor</code></a> which only supports evaluation of top-level lookups.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.lookup.StrSubstitutor">Fields inherited from class&nbsp;org.apache.logging.log4j.core.lookup.<a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></h3>
<code><a href="StrSubstitutor.html#DEFAULT_ESCAPE">DEFAULT_ESCAPE</a>, <a href="StrSubstitutor.html#DEFAULT_PREFIX">DEFAULT_PREFIX</a>, <a href="StrSubstitutor.html#DEFAULT_SUFFIX">DEFAULT_SUFFIX</a>, <a href="StrSubstitutor.html#DEFAULT_VALUE_DELIMITER">DEFAULT_VALUE_DELIMITER</a>, <a href="StrSubstitutor.html#DEFAULT_VALUE_DELIMITER_STRING">DEFAULT_VALUE_DELIMITER_STRING</a>, <a href="StrSubstitutor.html#DEFAULT_VALUE_ESCAPE_DELIMITER">DEFAULT_VALUE_ESCAPE_DELIMITER</a>, <a href="StrSubstitutor.html#ESCAPE_DELIMITER_STRING">ESCAPE_DELIMITER_STRING</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RuntimeStrSubstitutor</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.Map)" class="member-name-link">RuntimeStrSubstitutor</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;valueMap)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Properties)" class="member-name-link">RuntimeStrSubstitutor</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a>&nbsp;properties)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrLookup)" class="member-name-link">RuntimeStrSubstitutor</a><wbr>(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a>&nbsp;lookup)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.lookup.StrSubstitutor)" class="member-name-link">RuntimeStrSubstitutor</a><wbr>(<a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;other)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.lookup.StrSubstitutor">Methods inherited from class&nbsp;org.apache.logging.log4j.core.lookup.<a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></h3>
<code><a href="StrSubstitutor.html#appendWithSeparators(java.lang.StringBuilder,java.lang.Iterable,java.lang.String)">appendWithSeparators</a>, <a href="StrSubstitutor.html#getEscapeChar()">getEscapeChar</a>, <a href="StrSubstitutor.html#getValueDelimiterMatcher()">getValueDelimiterMatcher</a>, <a href="StrSubstitutor.html#getVariablePrefixMatcher()">getVariablePrefixMatcher</a>, <a href="StrSubstitutor.html#getVariableResolver()">getVariableResolver</a>, <a href="StrSubstitutor.html#getVariableSuffixMatcher()">getVariableSuffixMatcher</a>, <a href="StrSubstitutor.html#isEnableSubstitutionInVariables()">isEnableSubstitutionInVariables</a>, <a href="StrSubstitutor.html#replace(char%5B%5D)">replace</a>, <a href="StrSubstitutor.html#replace(char%5B%5D,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.Object)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.Object,java.util.Map)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.Object,java.util.Map,java.lang.String,java.lang.String)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.Object,java.util.Properties)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.String)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.StringBuffer)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.StringBuffer,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.StringBuilder)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.StringBuilder,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(java.lang.String,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,char%5B%5D)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,char%5B%5D,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.Object)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.String)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)">replace</a>, <a href="StrSubstitutor.html#replace(org.apache.logging.log4j.core.LogEvent,java.lang.String,int,int)">replace</a>, <a href="StrSubstitutor.html#replaceIn(java.lang.StringBuffer)">replaceIn</a>, <a href="StrSubstitutor.html#replaceIn(java.lang.StringBuffer,int,int)">replaceIn</a>, <a href="StrSubstitutor.html#replaceIn(java.lang.StringBuilder)">replaceIn</a>, <a href="StrSubstitutor.html#replaceIn(java.lang.StringBuilder,int,int)">replaceIn</a>, <a href="StrSubstitutor.html#replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuffer,int,int)">replaceIn</a>, <a href="StrSubstitutor.html#replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder)">replaceIn</a>, <a href="StrSubstitutor.html#replaceIn(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)">replaceIn</a>, <a href="StrSubstitutor.html#resolveVariable(org.apache.logging.log4j.core.LogEvent,java.lang.String,java.lang.StringBuilder,int,int)">resolveVariable</a>, <a href="StrSubstitutor.html#setConfiguration(org.apache.logging.log4j.core.config.Configuration)">setConfiguration</a>, <a href="StrSubstitutor.html#setEnableSubstitutionInVariables(boolean)">setEnableSubstitutionInVariables</a>, <a href="StrSubstitutor.html#setEscapeChar(char)">setEscapeChar</a>, <a href="StrSubstitutor.html#setValueDelimiter(char)">setValueDelimiter</a>, <a href="StrSubstitutor.html#setValueDelimiter(java.lang.String)">setValueDelimiter</a>, <a href="StrSubstitutor.html#setValueDelimiterMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)">setValueDelimiterMatcher</a>, <a href="StrSubstitutor.html#setVariablePrefix(char)">setVariablePrefix</a>, <a href="StrSubstitutor.html#setVariablePrefix(java.lang.String)">setVariablePrefix</a>, <a href="StrSubstitutor.html#setVariablePrefixMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)">setVariablePrefixMatcher</a>, <a href="StrSubstitutor.html#setVariableResolver(org.apache.logging.log4j.core.lookup.StrLookup)">setVariableResolver</a>, <a href="StrSubstitutor.html#setVariableSuffix(char)">setVariableSuffix</a>, <a href="StrSubstitutor.html#setVariableSuffix(java.lang.String)">setVariableSuffix</a>, <a href="StrSubstitutor.html#setVariableSuffixMatcher(org.apache.logging.log4j.core.lookup.StrMatcher)">setVariableSuffixMatcher</a>, <a href="StrSubstitutor.html#substitute(org.apache.logging.log4j.core.LogEvent,java.lang.StringBuilder,int,int)">substitute</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>RuntimeStrSubstitutor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RuntimeStrSubstitutor</span>()</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.util.Map)">
<h3>RuntimeStrSubstitutor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RuntimeStrSubstitutor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;valueMap)</span></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.util.Properties)">
<h3>RuntimeStrSubstitutor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RuntimeStrSubstitutor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a>&nbsp;properties)</span></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.logging.log4j.core.lookup.StrLookup)">
<h3>RuntimeStrSubstitutor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RuntimeStrSubstitutor</span><wbr><span class="parameters">(<a href="StrLookup.html" title="interface in org.apache.logging.log4j.core.lookup">StrLookup</a>&nbsp;lookup)</span></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.logging.log4j.core.lookup.StrSubstitutor)">
<h3>RuntimeStrSubstitutor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RuntimeStrSubstitutor</span><wbr><span class="parameters">(<a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a>&nbsp;other)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="StrSubstitutor.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="StrSubstitutor.html" title="class in org.apache.logging.log4j.core.lookup">StrSubstitutor</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>