AbstractSortedSetDecorator.java

  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. import java.util.Comparator;
  19. import java.util.Set;
  20. import java.util.SortedSet;

  21. /**
  22.  * Decorates another {@code SortedSet} to provide additional behavior.
  23.  * <p>
  24.  * Methods are forwarded directly to the decorated set.
  25.  * </p>
  26.  *
  27.  * @param <E> the type of the elements in the sorted set
  28.  * @since 3.0
  29.  */
  30. public abstract class AbstractSortedSetDecorator<E>
  31.         extends AbstractSetDecorator<E>
  32.         implements SortedSet<E> {

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

  35.     /**
  36.      * Constructor only used in deserialization, do not use otherwise.
  37.      * @since 3.1
  38.      */
  39.     protected AbstractSortedSetDecorator() {
  40.     }

  41.     /**
  42.      * Constructor that wraps (not copies).
  43.      *
  44.      * @param set  the set to decorate, must not be null
  45.      * @throws NullPointerException if set is null
  46.      */
  47.     protected AbstractSortedSetDecorator(final Set<E> set) {
  48.         super(set);
  49.     }

  50.     @Override
  51.     public Comparator<? super E> comparator() {
  52.         return decorated().comparator();
  53.     }

  54.     /**
  55.      * Gets the set being decorated.
  56.      *
  57.      * @return the decorated set
  58.      */
  59.     @Override
  60.     protected SortedSet<E> decorated() {
  61.         return (SortedSet<E>) super.decorated();
  62.     }

  63.     @Override
  64.     public E first() {
  65.         return decorated().first();
  66.     }

  67.     @Override
  68.     public SortedSet<E> headSet(final E toElement) {
  69.         return decorated().headSet(toElement);
  70.     }

  71.     @Override
  72.     public E last() {
  73.         return decorated().last();
  74.     }

  75.     @Override
  76.     public SortedSet<E> subSet(final E fromElement, final E toElement) {
  77.         return decorated().subSet(fromElement, toElement);
  78.     }

  79.     @Override
  80.     public SortedSet<E> tailSet(final E fromElement) {
  81.         return decorated().tailSet(fromElement);
  82.     }

  83. }