org.apache.commons.collections4.set.AbstractSortedSetDecorator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-collections4 Show documentation

The Apache Commons Collections package contains types that extend and augment the Java Collections Framework.

There is a newer version: 4.5.0-M1

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.collections4.set;

import java.util.Comparator;
import java.util.Set;
import java.util.SortedSet;

/**
 * Decorates another SortedSet to provide additional behaviour.
 * 
 * Methods are forwarded directly to the decorated set.
 *
 * @param  the type of the elements in the sorted set
 * @since 3.0
 */
public abstract class AbstractSortedSetDecorator
        extends AbstractSetDecorator
        implements SortedSet {

    /** Serialization version */
    private static final long serialVersionUID = -3462240946294214398L;

    /**
     * Constructor only used in deserialization, do not use otherwise.
     * @since 3.1
     */
    protected AbstractSortedSetDecorator() {
        super();
    }

    /**
     * Constructor that wraps (not copies).
     *
     * @param set  the set to decorate, must not be null
     * @throws NullPointerException if set is null
     */
    protected AbstractSortedSetDecorator(final Set set) {
        super(set);
    }

    /**
     * Gets the set being decorated.
     *
     * @return the decorated set
     */
    @Override
    protected SortedSet decorated() {
        return (SortedSet) super.decorated();
    }

    //-----------------------------------------------------------------------
    @Override
    public SortedSet subSet(final E fromElement, final E toElement) {
        return decorated().subSet(fromElement, toElement);
    }

    @Override
    public SortedSet headSet(final E toElement) {
        return decorated().headSet(toElement);
    }

    @Override
    public SortedSet tailSet(final E fromElement) {
        return decorated().tailSet(fromElement);
    }

    @Override
    public E first() {
        return decorated().first();
    }

    @Override
    public E last() {
        return decorated().last();
    }

    @Override
    public Comparator comparator() {
        return decorated().comparator();
    }

}