| <!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 (version 1.7.0_80) on Sun Oct 02 12:24:44 MST 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ReadOnlyStringMap (Apache Log4j API 2.7 API)</title> |
| <meta name="date" content="2016-10-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ReadOnlyStringMap (Apache Log4j API 2.7 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/util/ProviderUtil.html" title="class in org.apache.logging.log4j.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/util/ReflectionUtil.html" title="class in org.apache.logging.log4j.util"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/util/ReadOnlyStringMap.html" target="_top">Frames</a></li> |
| <li><a href="ReadOnlyStringMap.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.util</div> |
| <h2 title="Interface ReadOnlyStringMap" class="title">Interface ReadOnlyStringMap</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/logging/log4j/util/StringMap.html" title="interface in org.apache.logging.log4j.util">StringMap</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/logging/log4j/spi/DefaultThreadContextMap.html" title="class in org.apache.logging.log4j.spi">DefaultThreadContextMap</a>, <a href="../../../../../org/apache/logging/log4j/util/SortedArrayStringMap.html" title="class in org.apache.logging.log4j.util">SortedArrayStringMap</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.27">ReadOnlyStringMap</a> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">A read-only collection of String keys mapped to values of arbitrary type.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.7</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#containsKey(java.lang.String)">containsKey</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Returns <code>true</code> if this data structure contains the specified key, <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><V> void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#forEach(org.apache.logging.log4j.util.BiConsumer)">forEach</a></strong>(<a href="../../../../../org/apache/logging/log4j/util/BiConsumer.html" title="interface in org.apache.logging.log4j.util">BiConsumer</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? super V> action)</code> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><V,S> void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#forEach(org.apache.logging.log4j.util.TriConsumer,%20S)">forEach</a></strong>(<a href="../../../../../org/apache/logging/log4j/util/TriConsumer.html" title="interface in org.apache.logging.log4j.util">TriConsumer</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? super V,S> action, |
| S state)</code> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><V> V</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#getValue(java.lang.String)">getValue</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#isEmpty()">isEmpty</a></strong>()</code> |
| <div class="block">Returns <code>true</code> if this collection is empty (size is zero), <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#size()">size</a></strong>()</code> |
| <div class="block">Returns the number of key-value pairs in this collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#toMap()">toMap</a></strong>()</code> |
| <div class="block">Returns a non-<code>null</code> mutable <code>Map<String, String></code> containing a snapshot of this data structure.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="toMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toMap</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/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/util/ReadOnlyStringMap.html#line.33">toMap</a>()</pre> |
| <div class="block">Returns a non-<code>null</code> mutable <code>Map<String, String></code> containing a snapshot of this data structure.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a mutable copy of this data structure in <code>Map<String, String></code> form</dd></dl> |
| </li> |
| </ul> |
| <a name="containsKey(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsKey</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.41">containsKey</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Returns <code>true</code> if this data structure contains the specified key, <code>false</code> otherwise.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key whose presence to check. May be <code>null</code>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this data structure contains the specified key, <code>false</code> otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="forEach(org.apache.logging.log4j.util.BiConsumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEach</h4> |
| <pre><V> void <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.59">forEach</a>(<a href="../../../../../org/apache/logging/log4j/util/BiConsumer.html" title="interface in org.apache.logging.log4j.util">BiConsumer</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? super V> action)</pre> |
| <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="../../../../../org/apache/logging/log4j/util/BiConsumer.html#accept(K,%20V)"><code>BiConsumer.accept(Object, Object)</code></a> accept} method may cause a |
| <code>ConcurrentModificationException</code> to be thrown. |
| </p></div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>V</code> - type of the value</dd><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - The action to be performed for each key-value pair in this collection</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util">ConcurrentModificationException</a></code> - some implementations may not support structural modifications |
| to this data structure while iterating over the contents with <a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#forEach(org.apache.logging.log4j.util.BiConsumer)"><code>forEach(BiConsumer)</code></a> or |
| <a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#forEach(org.apache.logging.log4j.util.TriConsumer,%20S)"><code>forEach(TriConsumer, Object)</code></a>.</dd></dl> |
| </li> |
| </ul> |
| <a name="forEach(org.apache.logging.log4j.util.TriConsumer,java.lang.Object)"> |
| <!-- --> |
| </a><a name="forEach(org.apache.logging.log4j.util.TriConsumer, S)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forEach</h4> |
| <pre><V,S> void <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.84">forEach</a>(<a href="../../../../../org/apache/logging/log4j/util/TriConsumer.html" title="interface in org.apache.logging.log4j.util">TriConsumer</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? super V,S> action, |
| S state)</pre> |
| <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="../../../../../org/apache/logging/log4j/util/TriConsumer.html#accept(K,%20V,%20S)"><code>accept</code></a> method may cause a |
| <code>ConcurrentModificationException</code> to be thrown. |
| </p></div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>V</code> - type of the value</dd><dd><code>S</code> - type of the third parameter</dd><dt><span class="strong">Parameters:</span></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><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util">ConcurrentModificationException</a></code> - some implementations may not support structural modifications |
| to this data structure while iterating over the contents with <a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#forEach(org.apache.logging.log4j.util.BiConsumer)"><code>forEach(BiConsumer)</code></a> or |
| <a href="../../../../../org/apache/logging/log4j/util/ReadOnlyStringMap.html#forEach(org.apache.logging.log4j.util.TriConsumer,%20S)"><code>forEach(TriConsumer, Object)</code></a>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre><V> V <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.92">getValue</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <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><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key whose value to return</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value for the specified key or <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="isEmpty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.98">isEmpty</a>()</pre> |
| <div class="block">Returns <code>true</code> if this collection is empty (size is zero), <code>false</code> otherwise.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this collection is empty (size is zero)</dd></dl> |
| </li> |
| </ul> |
| <a name="size()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/logging/log4j/util/ReadOnlyStringMap.html#line.105">size</a>()</pre> |
| <div class="block">Returns the number of key-value pairs in this collection.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the number of key-value pairs in this collection</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/util/ProviderUtil.html" title="class in org.apache.logging.log4j.util"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/util/ReflectionUtil.html" title="class in org.apache.logging.log4j.util"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/util/ReadOnlyStringMap.html" target="_top">Frames</a></li> |
| <li><a href="ReadOnlyStringMap.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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-2016 <a href="http://www.apache.org">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> |
