| <!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.util;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>/**<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * A read-only collection of String keys mapped to values of arbitrary type.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> *<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * @since 2.7<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> */<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>public interface ReadOnlyStringMap extends Serializable {<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> <a name="line.28"></a> |
| <span class="sourceLineNo">029</span> /**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Returns a non-{@code null} mutable {@code Map<String, String>} containing a snapshot of this data structure.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> *<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * @return a mutable copy of this data structure in {@code Map<String, String>} form.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> Map<String, String> toMap();<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Returns {@code true} if this data structure contains the specified key, {@code false} otherwise.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @param key the key whose presence to check. May be {@code null}.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @return {@code true} if this data structure contains the specified key, {@code false} otherwise.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> boolean containsKey(String key);<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Performs the given action for each key-value pair in this data structure<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * until all entries have been processed or the action throws an exception.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Some implementations may not support structural modifications (adding new elements or removing elements) while<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * iterating over the contents. In such implementations, attempts to add or remove elements from the<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@code BiConsumer}'s {@link BiConsumer#accept(Object, Object)} accept} method may cause a<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * {@code ConcurrentModificationException} to be thrown.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @param action The action to be performed for each key-value pair in this collection.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param <V> type of the value.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @throws java.util.ConcurrentModificationException some implementations may not support structural modifications<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * to this data structure while iterating over the contents with {@link #forEach(BiConsumer)} or<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * {@link #forEach(TriConsumer, Object)}.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> <V> void forEach(final BiConsumer<String, ? super V> action);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Performs the given action for each key-value pair in this data structure<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * until all entries have been processed or the action throws an exception.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * The third parameter lets callers pass in a stateful object to be modified with the key-value pairs,<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * so the TriConsumer implementation itself can be stateless and potentially reusable.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * </p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Some implementations may not support structural modifications (adding new elements or removing elements) while<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * iterating over the contents. In such implementations, attempts to add or remove elements from the<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * {@code TriConsumer}'s {@link TriConsumer#accept(Object, Object, Object) accept} method may cause a<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * {@code ConcurrentModificationException} to be thrown.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * </p><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> *<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param action The action to be performed for each key-value pair in this collection.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param state the object to be passed as the third parameter to each invocation on the specified<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * triconsumer.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param <V> type of the value.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param <S> type of the third parameter.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @throws java.util.ConcurrentModificationException some implementations may not support structural modifications<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * to this data structure while iterating over the contents with {@link #forEach(BiConsumer)} or<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * {@link #forEach(TriConsumer, Object)}.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> <V, S> void forEach(final TriConsumer<String, ? super V, S> action, final S state);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Returns the value for the specified key, or {@code null} if the specified key does not exist in this collection.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param key the key whose value to return.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return the value for the specified key or {@code null}.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> <V> V getValue(final String key);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Returns {@code true} if this collection is empty (size is zero), {@code false} otherwise.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @return {@code true} if this collection is empty (size is zero).<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> boolean isEmpty();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Returns the number of key-value pairs in this collection.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> *<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @return the number of key-value pairs in this collection.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> int size();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span>}<a name="line.107"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
