org.apache.commons.collections4.map.PredicatedSortedMap 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.map;

import java.util.Comparator;
import java.util.SortedMap;

import org.apache.commons.collections4.Predicate;

/**
 * Decorates another SortedMap to validate that additions
 * match a specified predicate.
 * 
 * This map exists to provide validation for the decorated map.
 * It is normally created to decorate an empty map.
 * If an object cannot be added to the map, an IllegalArgumentException is thrown.
 * 
 * 
 * One usage would be to ensure that no null keys are added to the map.
 * 
 *  *   SortedMap map =
 *     PredicatedSortedMap.predicatedSortedMap(new TreeMap(),
 *                                             NotNullPredicate.notNullPredicate(),
 *                                             null);
 * 
 * 
 * Note that PredicatedSortedMap is not synchronized and is not thread-safe.
 * If you wish to use this map from multiple threads concurrently, you must use
 * appropriate synchronization. The simplest approach is to wrap this map
 * using {@link java.util.Collections#synchronizedSortedMap}. This class may throw
 * exceptions when accessed by concurrent threads without synchronization.
 * 
 * 
 * This class is Serializable from Commons Collections 3.1.
 * 
 *
 * @param  the type of the keys in this map
 * @param  the type of the values in this map
 * @since 3.0
 */
public class PredicatedSortedMap extends PredicatedMap implements SortedMap {

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

    /**
     * Factory method to create a predicated (validating) sorted map.
     * 
     * If there are any elements already in the list being decorated, they
     * are validated.
     *
     * @param   the key type
     * @param   the value type
     * @param map  the map to decorate, must not be null
     * @param keyPredicate  the predicate to validate the keys, null means no check
     * @param valuePredicate  the predicate to validate to values, null means no check
     * @return a new predicated sorted map
     * @throws NullPointerException if the map is null
     * @since 4.0
     */
    public static  PredicatedSortedMap predicatedSortedMap(final SortedMap map,
            final Predicate keyPredicate, final Predicate valuePredicate) {
        return new PredicatedSortedMap<>(map, keyPredicate, valuePredicate);
    }

    //-----------------------------------------------------------------------
    /**
     * Constructor that wraps (not copies).
     *
     * @param map  the map to decorate, must not be null
     * @param keyPredicate  the predicate to validate the keys, null means no check
     * @param valuePredicate  the predicate to validate to values, null means no check
     * @throws NullPointerException if the map is null
     */
    protected PredicatedSortedMap(final SortedMap map, final Predicate keyPredicate,
            final Predicate valuePredicate) {
        super(map, keyPredicate, valuePredicate);
    }

    //-----------------------------------------------------------------------
    /**
     * Gets the map being decorated.
     *
     * @return the decorated map
     */
    protected SortedMap getSortedMap() {
        return (SortedMap) map;
    }

    //-----------------------------------------------------------------------
    @Override
    public K firstKey() {
        return getSortedMap().firstKey();
    }

    @Override
    public K lastKey() {
        return getSortedMap().lastKey();
    }

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

    @Override
    public SortedMap subMap(final K fromKey, final K toKey) {
        final SortedMap map = getSortedMap().subMap(fromKey, toKey);
        return new PredicatedSortedMap<>(map, keyPredicate, valuePredicate);
    }

    @Override
    public SortedMap headMap(final K toKey) {
        final SortedMap map = getSortedMap().headMap(toKey);
        return new PredicatedSortedMap<>(map, keyPredicate, valuePredicate);
    }

    @Override
    public SortedMap tailMap(final K fromKey) {
        final SortedMap map = getSortedMap().tailMap(fromKey);
        return new PredicatedSortedMap<>(map, keyPredicate, valuePredicate);
    }

}