View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.util;
18  
19  /**
20   * An extension of {@code StringMap} that imposes a total ordering on its keys.
21   * The map is ordered according to the natural ordering of its keys. This order is reflected when
22   * {@link #forEach(BiConsumer) consuming} the key-value pairs with a {@link BiConsumer} or a {@link TriConsumer}.
23   * <p>
24   * This interface views all key-value pairs as a sequence ordered by key, and allows
25   * keys and values to be accessed by their index in the sequence.
26   * </p>
27   *
28   * @see IndexedReadOnlyStringMap
29   * @see StringMap
30   * @since 2.8
31   */
32  public interface IndexedStringMap extends IndexedReadOnlyStringMap, StringMap {
33  }