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 *      http://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.SortedSet;
021
022import org.apache.commons.collections4.Predicate;
023
024/**
025 * Decorates another <code>SortedSet</code> to validate that all additions
026 * match a specified predicate.
027 * <p>
028 * This set exists to provide validation for the decorated set.
029 * It is normally created to decorate an empty set.
030 * If an object cannot be added to the set, an IllegalArgumentException is thrown.
031 * <p>
032 * One usage would be to ensure that no null entries are added to the set.
033 * <pre>SortedSet set = PredicatedSortedSet.decorate(new TreeSet(), NotNullPredicate.INSTANCE);</pre>
034 * <p>
035 * This class is Serializable from Commons Collections 3.1.
036 *
037 * @since 3.0
038 * @version $Id: PredicatedSortedSet.html 972421 2015-11-14 20:00:04Z tn $
039 */
040public class PredicatedSortedSet<E> extends PredicatedSet<E> implements SortedSet<E> {
041
042    /** Serialization version */
043    private static final long serialVersionUID = -9110948148132275052L;
044
045    /**
046     * Factory method to create a predicated (validating) sorted set.
047     * <p>
048     * If there are any elements already in the set being decorated, they
049     * are validated.
050     *
051     * @param <E> the element type
052     * @param set  the set to decorate, must not be null
053     * @param predicate  the predicate to use for validation, must not be null
054     * @return a new predicated sorted set.
055     * @throws IllegalArgumentException if set or predicate is null
056     * @throws IllegalArgumentException if the set contains invalid elements
057     * @since 4.0
058     */
059    public static <E> PredicatedSortedSet<E> predicatedSortedSet(final SortedSet<E> set,
060                                                                 final Predicate<? super E> predicate) {
061        return new PredicatedSortedSet<E>(set, predicate);
062    }
063
064    //-----------------------------------------------------------------------
065    /**
066     * Constructor that wraps (not copies).
067     * <p>
068     * If there are any elements already in the set being decorated, they
069     * are validated.
070     *
071     * @param set  the set to decorate, must not be null
072     * @param predicate  the predicate to use for validation, must not be null
073     * @throws IllegalArgumentException if set or predicate is null
074     * @throws IllegalArgumentException if the set contains invalid elements
075     */
076    protected PredicatedSortedSet(final SortedSet<E> set, final Predicate<? super E> predicate) {
077        super(set, predicate);
078    }
079
080    /**
081     * Gets the sorted set being decorated.
082     *
083     * @return the decorated sorted set
084     */
085    @Override
086    protected SortedSet<E> decorated() {
087        return (SortedSet<E>) super.decorated();
088    }
089
090    //-----------------------------------------------------------------------
091    public Comparator<? super E> comparator() {
092        return decorated().comparator();
093    }
094
095    public E first() {
096        return decorated().first();
097    }
098
099    public E last() {
100        return decorated().last();
101    }
102
103    public SortedSet<E> subSet(final E fromElement, final E toElement) {
104        final SortedSet<E> sub = decorated().subSet(fromElement, toElement);
105        return new PredicatedSortedSet<E>(sub, predicate);
106    }
107
108    public SortedSet<E> headSet(final E toElement) {
109        final SortedSet<E> sub = decorated().headSet(toElement);
110        return new PredicatedSortedSet<E>(sub, predicate);
111    }
112
113    public SortedSet<E> tailSet(final E fromElement) {
114        final SortedSet<E> sub = decorated().tailSet(fromElement);
115        return new PredicatedSortedSet<E>(sub, predicate);
116    }
117
118}