All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.groupbyinc.common.apache.commons.collections4.set.PredicatedNavigableSet Maven / Gradle / Ivy

There is a newer version: 198
Show newest version
/*
 * 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.Iterator;
import java.util.NavigableSet;

import org.apache.commons.collections4.Predicate;

/**
 * Decorates another NavigableSet to validate that all additions
 * match a specified predicate.
 * 

* This set exists to provide validation for the decorated set. * It is normally created to decorate an empty set. * If an object cannot be added to the set, an IllegalArgumentException is thrown. *

* One usage would be to ensure that no null entries are added to the set. *

 * NavigableSet set =
 *   PredicatedSortedSet.predicatedNavigableSet(new TreeSet(),
 *                                              NotNullPredicate.notNullPredicate());
 * 
* * @since 4.1 * @version $Id: PredicatedNavigableSet.java 1686855 2015-06-22 13:00:27Z tn $ */ public class PredicatedNavigableSet extends PredicatedSortedSet implements NavigableSet { /** Serialization version */ private static final long serialVersionUID = 20150528L; /** * Factory method to create a predicated (validating) navigable set. *

* If there are any elements already in the set being decorated, they * are validated. * * @param the element type * @param set the set to decorate, must not be null * @param predicate the predicate to use for validation, must not be null * @return a new predicated navigable set. * @throws NullPointerException if set or predicate is null * @throws IllegalArgumentException if the set contains invalid elements * @since 4.0 */ public static PredicatedNavigableSet predicatedNavigableSet(final NavigableSet set, final Predicate predicate) { return new PredicatedNavigableSet(set, predicate); } //----------------------------------------------------------------------- /** * Constructor that wraps (not copies). *

* If there are any elements already in the set being decorated, they * are validated. * * @param set the set to decorate, must not be null * @param predicate the predicate to use for validation, must not be null * @throws NullPointerException if set or predicate is null * @throws IllegalArgumentException if the set contains invalid elements */ protected PredicatedNavigableSet(final NavigableSet set, final Predicate predicate) { super(set, predicate); } /** * Gets the navigable set being decorated. * * @return the decorated navigable set */ @Override protected NavigableSet decorated() { return (NavigableSet) super.decorated(); } //----------------------------------------------------------------------- @Override public E lower(E e) { return decorated().lower(e); } @Override public E floor(E e) { return decorated().floor(e); } @Override public E ceiling(E e) { return decorated().ceiling(e); } @Override public E higher(E e) { return decorated().higher(e); } @Override public E pollFirst() { return decorated().pollFirst(); } @Override public E pollLast() { return decorated().pollLast(); } @Override public NavigableSet descendingSet() { return predicatedNavigableSet(decorated().descendingSet(), predicate); } @Override public Iterator descendingIterator() { return decorated().descendingIterator(); } @Override public NavigableSet subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) { final NavigableSet sub = decorated().subSet(fromElement, fromInclusive, toElement, toInclusive); return predicatedNavigableSet(sub, predicate); } @Override public NavigableSet headSet(E toElement, boolean inclusive) { final NavigableSet head = decorated().headSet(toElement, inclusive); return predicatedNavigableSet(head, predicate); } @Override public NavigableSet tailSet(E fromElement, boolean inclusive) { final NavigableSet tail = decorated().tailSet(fromElement, inclusive); return predicatedNavigableSet(tail, predicate); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy