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.set;
18
19 import java.util.Comparator;
20 import java.util.Set;
21 import java.util.SortedSet;
22
23 /**
24 * Decorates another {@code SortedSet} to provide additional behavior.
25 * <p>
26 * Methods are forwarded directly to the decorated set.
27 * </p>
28 *
29 * @param <E> the type of the elements in the sorted set
30 * @since 3.0
31 */
32 public abstract class AbstractSortedSetDecorator<E>
33 extends AbstractSetDecorator<E>
34 implements SortedSet<E> {
35
36 /** Serialization version */
37 private static final long serialVersionUID = -3462240946294214398L;
38
39 /**
40 * Constructor only used in deserialization, do not use otherwise.
41 * @since 3.1
42 */
43 protected AbstractSortedSetDecorator() {
44 }
45
46 /**
47 * Constructor that wraps (not copies).
48 *
49 * @param set the set to decorate, must not be null
50 * @throws NullPointerException if set is null
51 */
52 protected AbstractSortedSetDecorator(final Set<E> set) {
53 super(set);
54 }
55
56 @Override
57 public Comparator<? super E> comparator() {
58 return decorated().comparator();
59 }
60
61 /**
62 * Gets the set being decorated.
63 *
64 * @return the decorated set
65 */
66 @Override
67 protected SortedSet<E> decorated() {
68 return (SortedSet<E>) super.decorated();
69 }
70
71 @Override
72 public E first() {
73 return decorated().first();
74 }
75
76 @Override
77 public SortedSet<E> headSet(final E toElement) {
78 return decorated().headSet(toElement);
79 }
80
81 @Override
82 public E last() {
83 return decorated().last();
84 }
85
86 @Override
87 public SortedSet<E> subSet(final E fromElement, final E toElement) {
88 return decorated().subSet(fromElement, toElement);
89 }
90
91 @Override
92 public SortedSet<E> tailSet(final E fromElement) {
93 return decorated().tailSet(fromElement);
94 }
95
96 }