001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.util;
018
019/**
020 * An extension of {@code StringMap} that imposes a total ordering on its keys.
021 * The map is ordered according to the natural ordering of its keys. This order is reflected when
022 * {@link #forEach(BiConsumer) consuming} the key-value pairs with a {@link BiConsumer} or a {@link TriConsumer}.
023 * <p>
024 * This interface views all key-value pairs as a sequence ordered by key, and allows
025 * keys and values to be accessed by their index in the sequence.
026 * </p>
027 *
028 * @see IndexedReadOnlyStringMap
029 * @see StringMap
030 * @since 2.8
031 */
032public interface IndexedStringMap extends IndexedReadOnlyStringMap, StringMap {
033}