| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ReadOnlyStringMap (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.util, interface: ReadOnlyStringMap"> |
| <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/ReadOnlyStringMap.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.util</a></div> |
| <h1 title="Interface ReadOnlyStringMap" class="title">Interface ReadOnlyStringMap</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</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></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="IndexedReadOnlyStringMap.html" title="interface in org.apache.logging.log4j.util">IndexedReadOnlyStringMap</a></code>, <code><a href="IndexedStringMap.html" title="interface in org.apache.logging.log4j.util">IndexedStringMap</a></code>, <code><a href="StringMap.html" title="interface in org.apache.logging.log4j.util">StringMap</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../spi/DefaultThreadContextMap.html" title="class in org.apache.logging.log4j.spi">DefaultThreadContextMap</a></code>, <code><a href="SortedArrayStringMap.html" title="class in org.apache.logging.log4j.util">SortedArrayStringMap</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ReadOnlyStringMap</span><span class="extends-implements"> |
| extends <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></span></div> |
| <div class="block">A read-only collection of String keys mapped to values of arbitrary type.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.7</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#containsKey(java.lang.String)" class="member-name-link">containsKey</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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns <code>true</code> if this data structure contains the specified key, <code>false</code> otherwise.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><V> void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forEach(org.apache.logging.log4j.util.BiConsumer)" class="member-name-link">forEach</a><wbr>(<a href="BiConsumer.html" title="interface in org.apache.logging.log4j.util">BiConsumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>? super V> action)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Performs the given action for each key-value pair in this data structure |
| until all entries have been processed or the action throws an exception.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><V,<wbr> |
| S> void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#forEach(org.apache.logging.log4j.util.TriConsumer,S)" class="member-name-link">forEach</a><wbr>(<a href="TriConsumer.html" title="interface in org.apache.logging.log4j.util">TriConsumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>? super V,<wbr>S> action, |
| S state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Performs the given action for each key-value pair in this data structure |
| until all entries have been processed or the action throws an exception.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><V> V</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValue(java.lang.String)" class="member-name-link">getValue</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> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the value for the specified key, or <code>null</code> if the specified key does not exist in this collection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns <code>true</code> if this collection is empty (size is zero), <code>false</code> otherwise.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of key-value pairs in this collection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toMap()" class="member-name-link">toMap</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a non-<code>null</code> mutable <code>Map<String, String></code> containing a snapshot of this data structure.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="toMap()"> |
| <h3>toMap</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">toMap</span>()</div> |
| <div class="block">Returns a non-<code>null</code> mutable <code>Map<String, String></code> containing a snapshot of this data structure.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a mutable copy of this data structure in <code>Map<String, String></code> form.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsKey(java.lang.String)"> |
| <h3>containsKey</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">containsKey</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</span></div> |
| <div class="block">Returns <code>true</code> if this data structure contains the specified key, <code>false</code> otherwise.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key whose presence to check. May be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this data structure contains the specified key, <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forEach(org.apache.logging.log4j.util.BiConsumer)"> |
| <h3>forEach</h3> |
| <div class="member-signature"><span class="type-parameters"><V></span> <span class="return-type">void</span> <span class="element-name">forEach</span><wbr><span class="parameters">(<a href="BiConsumer.html" title="interface in org.apache.logging.log4j.util">BiConsumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>? super V> action)</span></div> |
| <div class="block">Performs the given action for each key-value pair in this data structure |
| until all entries have been processed or the action throws an exception. |
| <p> |
| Some implementations may not support structural modifications (adding new elements or removing elements) while |
| iterating over the contents. In such implementations, attempts to add or remove elements from the |
| <code>BiConsumer</code>'s <a href="BiConsumer.html#accept(K,V)"><code>BiConsumer.accept(Object, Object)</code></a> accept} method may cause a |
| <code>ConcurrentModificationException</code> to be thrown. |
| </p></div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - type of the value.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>action</code> - The action to be performed for each key-value pair in this collection.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link">ConcurrentModificationException</a></code> - some implementations may not support structural modifications |
| to this data structure while iterating over the contents with <a href="#forEach(org.apache.logging.log4j.util.BiConsumer)"><code>forEach(BiConsumer)</code></a> or |
| <a href="#forEach(org.apache.logging.log4j.util.TriConsumer,S)"><code>forEach(TriConsumer, Object)</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forEach(org.apache.logging.log4j.util.TriConsumer,S)"> |
| <h3 id="forEach(org.apache.logging.log4j.util.TriConsumer,java.lang.Object)">forEach</h3> |
| <div class="member-signature"><span class="type-parameters"><V,<wbr> |
| S></span> <span class="return-type">void</span> <span class="element-name">forEach</span><wbr><span class="parameters">(<a href="TriConsumer.html" title="interface in org.apache.logging.log4j.util">TriConsumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>? super V,<wbr>S> action, |
| S state)</span></div> |
| <div class="block">Performs the given action for each key-value pair in this data structure |
| until all entries have been processed or the action throws an exception. |
| <p> |
| The third parameter lets callers pass in a stateful object to be modified with the key-value pairs, |
| so the TriConsumer implementation itself can be stateless and potentially reusable. |
| </p> |
| <p> |
| Some implementations may not support structural modifications (adding new elements or removing elements) while |
| iterating over the contents. In such implementations, attempts to add or remove elements from the |
| <code>TriConsumer</code>'s <a href="TriConsumer.html#accept(K,V,S)"><code>accept</code></a> method may cause a |
| <code>ConcurrentModificationException</code> to be thrown. |
| </p></div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - type of the value.</dd> |
| <dd><code>S</code> - type of the third parameter.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>action</code> - The action to be performed for each key-value pair in this collection.</dd> |
| <dd><code>state</code> - the object to be passed as the third parameter to each invocation on the specified |
| triconsumer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link">ConcurrentModificationException</a></code> - some implementations may not support structural modifications |
| to this data structure while iterating over the contents with <a href="#forEach(org.apache.logging.log4j.util.BiConsumer)"><code>forEach(BiConsumer)</code></a> or |
| <a href="#forEach(org.apache.logging.log4j.util.TriConsumer,S)"><code>forEach(TriConsumer, Object)</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValue(java.lang.String)"> |
| <h3>getValue</h3> |
| <div class="member-signature"><span class="type-parameters"><V></span> <span class="return-type">V</span> <span class="element-name">getValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</span></div> |
| <div class="block">Returns the value for the specified key, or <code>null</code> if the specified key does not exist in this collection.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key whose value to return.</dd> |
| <dt>Returns:</dt> |
| <dd>the value for the specified key or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEmpty()"> |
| <h3>isEmpty</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> |
| <div class="block">Returns <code>true</code> if this collection is empty (size is zero), <code>false</code> otherwise.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this collection is empty (size is zero).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">size</span>()</div> |
| <div class="block">Returns the number of key-value pairs in this collection.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of key-value pairs in this collection.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
