Google Git
Sign in
apache / logging-log4j-site / c83555f00ebe8967fddd9bc20e8f01bbccf81ea2 / . / 2.x / javadoc / log4j-api / org / apache / logging / log4j / message / StringMapMessage.html
blob: 591066bdd508f2a2752f8de0d6a234594a8212b4 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>StringMapMessage (Apache Log4j API 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.message, class: StringMapMessage">
<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/StringMapMessage.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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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.message</a></div>
<h1 title="Class StringMapMessage" class="title">Class StringMapMessage</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="MapMessage.html" title="class in org.apache.logging.log4j.message">org.apache.logging.log4j.message.MapMessage</a>&lt;<a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message">StringMapMessage</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;
<div class="inheritance">org.apache.logging.log4j.message.StringMapMessage</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="Message.html" title="interface in org.apache.logging.log4j.message">Message</a></code>, <code><a href="MultiformatMessage.html" title="interface in org.apache.logging.log4j.message">MultiformatMessage</a></code>, <code><a href="../util/MultiFormatStringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">MultiFormatStringBuilderFormattable</a></code>, <code><a href="../util/StringBuilderFormattable.html" title="interface in org.apache.logging.log4j.util">StringBuilderFormattable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations"><a href="AsynchronouslyFormattable.html" title="annotation in org.apache.logging.log4j.message">@AsynchronouslyFormattable</a>
</span><span class="modifiers">public class </span><span class="element-name type-name-label">StringMapMessage</span>
<span class="extends-implements">extends <a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a>&lt;<a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message">StringMapMessage</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;</span></div>
<div class="block">A <a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message"><code>StringMapMessage</code></a> typed to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>-only values. This is like the MapMessage class before 2.9.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2.9</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../serialized-form.html#org.apache.logging.log4j.message.StringMapMessage">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.logging.log4j.message.MapMessage">Nested classes/interfaces inherited from class&nbsp;org.apache.logging.log4j.message.<a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></h2>
<code><a href="MapMessage.MapFormat.html" title="enum in org.apache.logging.log4j.message">MapMessage.MapFormat</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">StringMapMessage</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a new instance.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">StringMapMessage</a><wbr>(int&nbsp;initialCapacity)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructs a new instance.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map)" class="member-name-link">StringMapMessage</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;map)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a new instance based on an existing Map.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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="StringMapMessage.html" title="class in org.apache.logging.log4j.message">StringMapMessage</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newInstance(java.util.Map)" class="member-name-link">newInstance</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;map)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Constructs a new instance based on an existing Map.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.logging.log4j.message.MapMessage">Methods inherited from class&nbsp;org.apache.logging.log4j.message.<a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a></h3>
<code><a href="MapMessage.html#appendMap(java.lang.StringBuilder)">appendMap</a>, <a href="MapMessage.html#asJava(java.lang.StringBuilder)">asJava</a>, <a href="MapMessage.html#asJavaUnquoted(java.lang.StringBuilder)">asJavaUnquoted</a>, <a href="MapMessage.html#asJson(java.lang.StringBuilder)">asJson</a>, <a href="MapMessage.html#asString()">asString</a>, <a href="MapMessage.html#asString(java.lang.String)">asString</a>, <a href="MapMessage.html#asXml(java.lang.StringBuilder)">asXml</a>, <a href="MapMessage.html#clear()">clear</a>, <a href="MapMessage.html#containsKey(java.lang.String)">containsKey</a>, <a href="MapMessage.html#equals(java.lang.Object)">equals</a>, <a href="MapMessage.html#forEach(org.apache.logging.log4j.util.BiConsumer)">forEach</a>, <a href="MapMessage.html#forEach(org.apache.logging.log4j.util.TriConsumer,S)">forEach</a>, <a href="MapMessage.html#formatTo(java.lang.String%5B%5D,java.lang.StringBuilder)">formatTo</a>, <a href="MapMessage.html#formatTo(java.lang.StringBuilder)">formatTo</a>, <a href="MapMessage.html#get(java.lang.String)">get</a>, <a href="MapMessage.html#getData()">getData</a>, <a href="MapMessage.html#getFormat()">getFormat</a>, <a href="MapMessage.html#getFormats()">getFormats</a>, <a href="MapMessage.html#getFormattedMessage()">getFormattedMessage</a>, <a href="MapMessage.html#getFormattedMessage(java.lang.String%5B%5D)">getFormattedMessage</a>, <a href="MapMessage.html#getIndexedReadOnlyStringMap()">getIndexedReadOnlyStringMap</a>, <a href="MapMessage.html#getParameters()">getParameters</a>, <a href="MapMessage.html#getThrowable()">getThrowable</a>, <a href="MapMessage.html#hashCode()">hashCode</a>, <a href="MapMessage.html#put(java.lang.String,java.lang.String)">put</a>, <a href="MapMessage.html#putAll(java.util.Map)">putAll</a>, <a href="MapMessage.html#remove(java.lang.String)">remove</a>, <a href="MapMessage.html#toKey(java.lang.String)">toKey</a>, <a href="MapMessage.html#toString()">toString</a>, <a href="MapMessage.html#validate(java.lang.String,boolean)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,byte)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,char)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,double)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,float)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,int)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,long)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,short)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,java.lang.Object)">validate</a>, <a href="MapMessage.html#validate(java.lang.String,java.lang.String)">validate</a>, <a href="MapMessage.html#with(java.lang.String,boolean)">with</a>, <a href="MapMessage.html#with(java.lang.String,byte)">with</a>, <a href="MapMessage.html#with(java.lang.String,char)">with</a>, <a href="MapMessage.html#with(java.lang.String,double)">with</a>, <a href="MapMessage.html#with(java.lang.String,float)">with</a>, <a href="MapMessage.html#with(java.lang.String,int)">with</a>, <a href="MapMessage.html#with(java.lang.String,long)">with</a>, <a href="MapMessage.html#with(java.lang.String,short)">with</a>, <a href="MapMessage.html#with(java.lang.String,java.lang.Object)">with</a>, <a href="MapMessage.html#with(java.lang.String,java.lang.String)">with</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#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#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>StringMapMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">StringMapMessage</span>()</div>
<div class="block">Constructs a new instance.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int)">
<h3>StringMapMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">StringMapMessage</span><wbr><span class="parameters">(int&nbsp;initialCapacity)</span></div>
<div class="block">Constructs a new instance.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>initialCapacity</code> - the initial capacity.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.util.Map)">
<h3>StringMapMessage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">StringMapMessage</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;map)</span></div>
<div class="block">Constructs a new instance based on an existing Map.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>map</code> - The Map.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="newInstance(java.util.Map)">
<h3>newInstance</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message">StringMapMessage</a></span>&nbsp;<span class="element-name">newInstance</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;map)</span></div>
<div class="block">Constructs a new instance based on an existing Map.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="MapMessage.html#newInstance(java.util.Map)">newInstance</a></code>&nbsp;in class&nbsp;<code><a href="MapMessage.html" title="class in org.apache.logging.log4j.message">MapMessage</a>&lt;<a href="StringMapMessage.html" title="class in org.apache.logging.log4j.message">StringMapMessage</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;</code></dd>
<dt>Parameters:</dt>
<dd><code>map</code> - The Map.</dd>
<dt>Returns:</dt>
<dd>A new StringMapMessage</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>