/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.collections4;

import java.util.Collection;
import java.util.Comparator;

/**
 * Defines a type of {@code Bag} that maintains a sorted order among its unique representative members.
 * <p>
 * The {@link SortedMultiSet} interface provides the same functionality while complying with the {@link Collection Collection} contract, and should be preferred
 * for new code; see the {@link Bag} documentation for migration notes.
 * </p>
 *
 * @param <E> The type of elements in this bag.
 * @see SortedMultiSet
 * @since 2.0
 * @deprecated Since 4.6.0, use {@link SortedMultiSet} instead; see the {@link Bag} Javadoc for migration notes.
 */
@Deprecated
public interface SortedBag<E> extends Bag<E> {

    /**
     * Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
     *
     * @return The comparator in use, or null if natural ordering.
     */
    Comparator<? super E> comparator();

    /**
     * Returns the first (lowest) member.
     *
     * @return The first element in the sorted bag.
     */
    E first();

    /**
     * Returns the last (highest) member.
     *
     * @return The last element in the sorted bag.
     */
    E last();
}
