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.collections4.bag;
18
19 import java.util.Comparator;
20
21 import org.apache.commons.collections4.SortedBag;
22
23 /**
24 * Decorates another {@code SortedBag} to provide additional behavior.
25 * <p>
26 * Methods are forwarded directly to the decorated bag.
27 * </p>
28 *
29 * @param <E> the type of elements in this bag
30 * @since 3.0
31 */
32 public abstract class AbstractSortedBagDecorator<E>
33 extends AbstractBagDecorator<E> implements SortedBag<E> {
34
35 /** Serialization version */
36 private static final long serialVersionUID = -8223473624050467718L;
37
38 /**
39 * Constructor only used in deserialization, do not use otherwise.
40 * @since 3.1
41 */
42 protected AbstractSortedBagDecorator() {
43 }
44
45 /**
46 * Constructor that wraps (not copies).
47 *
48 * @param bag the bag to decorate, must not be null
49 * @throws NullPointerException if bag is null
50 */
51 protected AbstractSortedBagDecorator(final SortedBag<E> bag) {
52 super(bag);
53 }
54
55 @Override
56 public Comparator<? super E> comparator() {
57 return decorated().comparator();
58 }
59
60 /**
61 * Gets the bag being decorated.
62 *
63 * @return the decorated bag
64 */
65 @Override
66 protected SortedBag<E> decorated() {
67 return (SortedBag<E>) super.decorated();
68 }
69
70 @Override
71 public E first() {
72 return decorated().first();
73 }
74
75 @Override
76 public E last() {
77 return decorated().last();
78 }
79
80 }