Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / impl / JdkMapAdapterStringMap.html
blob: 4d9956a87ed18970885cd469f687628ed4364f6c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.impl;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Arrays;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Comparator;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.HashMap;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.util.BiConsumer;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.util.ReadOnlyStringMap;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.util.StringMap;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.util.TriConsumer;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Provides a read-only {@code StringMap} view of a {@code Map&lt;String, String&gt;}.<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class JdkMapAdapterStringMap implements StringMap {<a name="line.33"></a>
<span class="sourceLineNo">034</span> private static final long serialVersionUID = -7348247784983193612L;<a name="line.34"></a>
<span class="sourceLineNo">035</span> private static final String FROZEN = "Frozen collection cannot be modified";<a name="line.35"></a>
<span class="sourceLineNo">036</span> private static final Comparator&lt;? super String&gt; NULL_FIRST_COMPARATOR = new Comparator&lt;String&gt;() {<a name="line.36"></a>
<span class="sourceLineNo">037</span> @Override<a name="line.37"></a>
<span class="sourceLineNo">038</span> public int compare(final String left, final String right) {<a name="line.38"></a>
<span class="sourceLineNo">039</span> if (left == null) {<a name="line.39"></a>
<span class="sourceLineNo">040</span> return -1;<a name="line.40"></a>
<span class="sourceLineNo">041</span> }<a name="line.41"></a>
<span class="sourceLineNo">042</span> if (right == null) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> return 1;<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span> return left.compareTo(right);<a name="line.45"></a>
<span class="sourceLineNo">046</span> }<a name="line.46"></a>
<span class="sourceLineNo">047</span> };<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> private final Map&lt;String, String&gt; map;<a name="line.49"></a>
<span class="sourceLineNo">050</span> private boolean immutable = false;<a name="line.50"></a>
<span class="sourceLineNo">051</span> private transient String[] sortedKeys;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> public JdkMapAdapterStringMap() {<a name="line.53"></a>
<span class="sourceLineNo">054</span> this(new HashMap&lt;String, String&gt;());<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> public JdkMapAdapterStringMap(final Map&lt;String, String&gt; map) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> this.map = Objects.requireNonNull(map, "map");<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> @Override<a name="line.61"></a>
<span class="sourceLineNo">062</span> public Map&lt;String, String&gt; toMap() {<a name="line.62"></a>
<span class="sourceLineNo">063</span> return map;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private void assertNotFrozen() {<a name="line.66"></a>
<span class="sourceLineNo">067</span> if (immutable) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> throw new UnsupportedOperationException(FROZEN);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span> public boolean containsKey(final String key) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return map.containsKey(key);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> @SuppressWarnings("unchecked")<a name="line.77"></a>
<span class="sourceLineNo">078</span> @Override<a name="line.78"></a>
<span class="sourceLineNo">079</span> public &lt;V&gt; void forEach(final BiConsumer&lt;String, ? super V&gt; action) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> final String[] keys = getSortedKeys();<a name="line.80"></a>
<span class="sourceLineNo">081</span> for (int i = 0; i &lt; keys.length; i++) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> action.accept(keys[i], (V) map.get(keys[i]));<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> @SuppressWarnings("unchecked")<a name="line.86"></a>
<span class="sourceLineNo">087</span> @Override<a name="line.87"></a>
<span class="sourceLineNo">088</span> public &lt;V, S&gt; void forEach(final TriConsumer&lt;String, ? super V, S&gt; action, final S state) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> final String[] keys = getSortedKeys();<a name="line.89"></a>
<span class="sourceLineNo">090</span> for (int i = 0; i &lt; keys.length; i++) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> action.accept(keys[i], (V) map.get(keys[i]), state);<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> private String[] getSortedKeys() {<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (sortedKeys == null) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> sortedKeys = map.keySet().toArray(new String[map.size()]);<a name="line.97"></a>
<span class="sourceLineNo">098</span> Arrays.sort(sortedKeys, NULL_FIRST_COMPARATOR);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> return sortedKeys;<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> @SuppressWarnings("unchecked")<a name="line.103"></a>
<span class="sourceLineNo">104</span> @Override<a name="line.104"></a>
<span class="sourceLineNo">105</span> public &lt;V&gt; V getValue(final String key) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return (V) map.get(key);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> @Override<a name="line.109"></a>
<span class="sourceLineNo">110</span> public boolean isEmpty() {<a name="line.110"></a>
<span class="sourceLineNo">111</span> return map.isEmpty();<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> @Override<a name="line.114"></a>
<span class="sourceLineNo">115</span> public int size() {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return map.size();<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> @Override<a name="line.119"></a>
<span class="sourceLineNo">120</span> public void clear() {<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (map.isEmpty()) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> return;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> assertNotFrozen();<a name="line.124"></a>
<span class="sourceLineNo">125</span> map.clear();<a name="line.125"></a>
<span class="sourceLineNo">126</span> sortedKeys = null;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span> public void freeze() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> immutable = true;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span> public boolean isFrozen() {<a name="line.135"></a>
<span class="sourceLineNo">136</span> return immutable;<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> @Override<a name="line.139"></a>
<span class="sourceLineNo">140</span> public void putAll(final ReadOnlyStringMap source) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> assertNotFrozen();<a name="line.141"></a>
<span class="sourceLineNo">142</span> source.forEach(PUT_ALL, map);<a name="line.142"></a>
<span class="sourceLineNo">143</span> sortedKeys = null;<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> private static TriConsumer&lt;String, String, Map&lt;String, String&gt;&gt; PUT_ALL = new TriConsumer&lt;String, String, Map&lt;String, String&gt;&gt;() {<a name="line.146"></a>
<span class="sourceLineNo">147</span> @Override<a name="line.147"></a>
<span class="sourceLineNo">148</span> public void accept(final String key, final String value, final Map&lt;String, String&gt; stringStringMap) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> stringStringMap.put(key, value);<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> };<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> @Override<a name="line.153"></a>
<span class="sourceLineNo">154</span> public void putValue(final String key, final Object value) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> assertNotFrozen();<a name="line.155"></a>
<span class="sourceLineNo">156</span> map.put(key, value == null ? null : String.valueOf(value));<a name="line.156"></a>
<span class="sourceLineNo">157</span> sortedKeys = null;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> @Override<a name="line.160"></a>
<span class="sourceLineNo">161</span> public void remove(final String key) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (!map.containsKey(key)) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> assertNotFrozen();<a name="line.165"></a>
<span class="sourceLineNo">166</span> map.remove(key);<a name="line.166"></a>
<span class="sourceLineNo">167</span> sortedKeys = null;<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> @Override<a name="line.170"></a>
<span class="sourceLineNo">171</span> public String toString() {<a name="line.171"></a>
<span class="sourceLineNo">172</span> final StringBuilder result = new StringBuilder(map.size() * 13);<a name="line.172"></a>
<span class="sourceLineNo">173</span> result.append('{');<a name="line.173"></a>
<span class="sourceLineNo">174</span> final String[] keys = getSortedKeys();<a name="line.174"></a>
<span class="sourceLineNo">175</span> for (int i = 0; i &lt; keys.length; i++) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> if (i &gt; 0) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> result.append(", ");<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span> result.append(keys[i]).append('=').append(map.get(keys[i]));<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> result.append('}');<a name="line.181"></a>
<span class="sourceLineNo">182</span> return result.toString();<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span> public boolean equals(final Object object) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (object == this) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> return true;<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (!(object instanceof JdkMapAdapterStringMap)) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> return false;<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> final JdkMapAdapterStringMap other = (JdkMapAdapterStringMap) object;<a name="line.193"></a>
<span class="sourceLineNo">194</span> return map.equals(other.map) &amp;&amp; immutable == other.immutable;<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> @Override<a name="line.197"></a>
<span class="sourceLineNo">198</span> public int hashCode() {<a name="line.198"></a>
<span class="sourceLineNo">199</span> return map.hashCode() + (immutable ? 31 : 0);<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span>}<a name="line.201"></a>
</pre>
</div>
</body>
</html>