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 * https://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
18 package org.apache.commons.collections4;
19
20 import java.util.Collection;
21 import java.util.Comparator;
22
23 /**
24 * Defines a type of {@code Bag} that maintains a sorted order among its unique representative members.
25 * <p>
26 * The {@link SortedMultiSet} interface provides the same functionality while complying with the {@link Collection Collection} contract, and should be preferred
27 * for new code; see the {@link Bag} documentation for migration notes.
28 * </p>
29 *
30 * @param <E> The type of elements in this bag.
31 * @see SortedMultiSet
32 * @since 2.0
33 * @deprecated Since 4.6.0, use {@link SortedMultiSet} instead; see the {@link Bag} Javadoc for migration notes.
34 */
35 @Deprecated
36 public interface SortedBag<E> extends Bag<E> {
37
38 /**
39 * Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
40 *
41 * @return The comparator in use, or null if natural ordering.
42 */
43 Comparator<? super E> comparator();
44
45 /**
46 * Returns the first (lowest) member.
47 *
48 * @return The first element in the sorted bag.
49 */
50 E first();
51
52 /**
53 * Returns the last (highest) member.
54 *
55 * @return The last element in the sorted bag.
56 */
57 E last();
58 }