001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4.set;
018
019import java.util.Comparator;
020import java.util.Set;
021import java.util.SortedSet;
022
023/**
024 * Decorates another {@code SortedSet} to provide additional behavior.
025 * <p>
026 * Methods are forwarded directly to the decorated set.
027 * </p>
028 *
029 * @param <E> The type of the elements in the sorted set
030 * @since 3.0
031 */
032public abstract class AbstractSortedSetDecorator<E>
033        extends AbstractSetDecorator<E>
034        implements SortedSet<E> {
035
036    /** Serialization version */
037    private static final long serialVersionUID = -3462240946294214398L;
038
039    /**
040     * Constructor only used in deserialization, do not use otherwise.
041     *
042     * @since 3.1
043     */
044    protected AbstractSortedSetDecorator() {
045    }
046
047    /**
048     * Constructor that wraps (not copies).
049     *
050     * @param set  The set to decorate, must not be null
051     * @throws NullPointerException if set is null
052     */
053    protected AbstractSortedSetDecorator(final Set<E> set) {
054        super(set);
055    }
056
057    @Override
058    public Comparator<? super E> comparator() {
059        return decorated().comparator();
060    }
061
062    /**
063     * Gets the set being decorated.
064     *
065     * @return The decorated set
066     */
067    @Override
068    protected SortedSet<E> decorated() {
069        return (SortedSet<E>) super.decorated();
070    }
071
072    @Override
073    public E first() {
074        return decorated().first();
075    }
076
077    @Override
078    public SortedSet<E> headSet(final E toElement) {
079        return decorated().headSet(toElement);
080    }
081
082    @Override
083    public E last() {
084        return decorated().last();
085    }
086
087    @Override
088    public SortedSet<E> subSet(final E fromElement, final E toElement) {
089        return decorated().subSet(fromElement, toElement);
090    }
091
092    @Override
093    public SortedSet<E> tailSet(final E fromElement) {
094        return decorated().tailSet(fromElement);
095    }
096
097}