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.commons.collections;
18
19 import java.util.Comparator;
20
21 /**
22 * Defines a type of <code>Bag</code> that maintains a sorted order among
23 * its unique representative members.
24 *
25 * @param <E> the type to iterate over
26 * @since 2.0
27 * @version $Id: SortedBag.java 1361710 2012-07-15 15:00:21Z tn $
28 */
29 public interface SortedBag<E> extends Bag<E> {
30
31 /**
32 * Returns the comparator associated with this sorted set, or null
33 * if it uses its elements' natural ordering.
34 *
35 * @return the comparator in use, or null if natural ordering
36 */
37 public Comparator<? super E> comparator();
38
39 /**
40 * Returns the first (lowest) member.
41 *
42 * @return the first element in the sorted bag
43 */
44 public E first();
45
46 /**
47 * Returns the last (highest) member.
48 *
49 * @return the last element in the sorted bag
50 */
51 public E last();
52
53 }