| <!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>/**<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> * An extension of {@code ReadOnlyStringMap} that imposes a total ordering on its keys.<a name="line.20"></a> |
| <span class="sourceLineNo">021</span> * The map is ordered according to the natural ordering of its keys. This order is reflected when<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * {@link #forEach(BiConsumer) consuming} the key-value pairs with a {@link BiConsumer} or a {@link TriConsumer}.<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * <p><a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * This interface views all key-value pairs as a sequence ordered by key, and allows<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * keys and values to be accessed by their index in the sequence.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * </p><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @see ReadOnlyStringMap<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * @since 2.8<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public interface IndexedReadOnlyStringMap extends ReadOnlyStringMap {<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Viewing all key-value pairs as a sequence sorted by key, this method returns the key at the specified index,<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * or {@code null} if the specified index is less than zero or greater or equal to the size of this collection.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @param index the index of the key to return<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @return the key at the specified index or {@code null}<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> String getKeyAt(final int index);<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Viewing all key-value pairs as a sequence sorted by key, this method returns the value at the specified index,<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * or {@code null} if the specified index is less than zero or greater or equal to the size of this collection.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param index the index of the value to return<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @return the value at the specified index or {@code null}<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> <V> V getValueAt(final int index);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Viewing all key-value pairs as a sequence sorted by key, this method returns the index of the specified key in<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * that sequence. If the specified key is not found, this method returns {@code (-(insertion point) - 1)}.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param key the key whose index in the ordered sequence of keys to return<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @return the index of the specified key or {@code (-(insertion point) - 1)} if the key is not found.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * The insertion point is defined as the point at which the key would be inserted into the array:<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * the index of the first element in the range greater than the key, or {@code size()} if all elements<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * are less than the specified key. Note that this guarantees that the return value will be &gt;= 0<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * if and only if the key is found.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> int indexOfKey(final String key);<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>}<a name="line.63"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
