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.multiset;
018
019import java.util.Set;
020
021import org.apache.commons.collections4.MultiSet;
022import org.apache.commons.collections4.Predicate;
023import org.apache.commons.collections4.collection.PredicatedCollection;
024
025/**
026 * Decorates another {@link MultiSet} to validate that additions
027 * match a specified predicate.
028 * <p>
029 * This multiset exists to provide validation for the decorated multiset.
030 * It is normally created to decorate an empty multiset.
031 * If an object cannot be added to the multiset, an {@link IllegalArgumentException}
032 * is thrown.
033 * </p>
034 * <p>
035 * One usage would be to ensure that no null entries are added to the multiset.
036 * </p>
037 * <pre>
038 * MultiSet&lt;E&gt; set =
039 *      PredicatedMultiSet.predicatedMultiSet(new HashMultiSet&lt;E&gt;(),
040 *                                            NotNullPredicate.notNullPredicate());
041 * </pre>
042 *
043 * @param <E> the type held in the multiset
044 * @since 4.1
045 */
046public class PredicatedMultiSet<E> extends PredicatedCollection<E> implements MultiSet<E> {
047
048    /** Serialization version */
049    private static final long serialVersionUID = 20150629L;
050
051    /**
052     * Factory method to create a predicated (validating) multiset.
053     * <p>
054     * If there are any elements already in the multiset being decorated, they
055     * are validated.
056     *
057     * @param <E> the type of the elements in the multiset
058     * @param multiset  the multiset to decorate, must not be null
059     * @param predicate  the predicate to use for validation, must not be null
060     * @return a new predicated MultiSet
061     * @throws NullPointerException if multiset or predicate is null
062     * @throws IllegalArgumentException if the multiset contains invalid elements
063     */
064    public static <E> PredicatedMultiSet<E> predicatedMultiSet(final MultiSet<E> multiset,
065                                                               final Predicate<? super E> predicate) {
066        return new PredicatedMultiSet<>(multiset, predicate);
067    }
068
069    /**
070     * Constructor that wraps (not copies).
071     * <p>
072     * If there are any elements already in the multiset being decorated, they
073     * are validated.
074     *
075     * @param multiset  the multiset to decorate, must not be null
076     * @param predicate  the predicate to use for validation, must not be null
077     * @throws NullPointerException if multiset or predicate is null
078     * @throws IllegalArgumentException if the multiset contains invalid elements
079     */
080    protected PredicatedMultiSet(final MultiSet<E> multiset, final Predicate<? super E> predicate) {
081        super(multiset, predicate);
082    }
083
084    @Override
085    public int add(final E object, final int count) {
086        validate(object);
087        return decorated().add(object, count);
088    }
089
090    /**
091     * Gets the decorated multiset.
092     *
093     * @return the decorated multiset
094     */
095    @Override
096    protected MultiSet<E> decorated() {
097        return (MultiSet<E>) super.decorated();
098    }
099
100    @Override
101    public Set<MultiSet.Entry<E>> entrySet() {
102        return decorated().entrySet();
103    }
104
105    @Override
106    public boolean equals(final Object object) {
107        return object == this || decorated().equals(object);
108    }
109
110    @Override
111    public int getCount(final Object object) {
112        return decorated().getCount(object);
113    }
114
115    @Override
116    public int hashCode() {
117        return decorated().hashCode();
118    }
119
120    @Override
121    public int remove(final Object object, final int count) {
122        return decorated().remove(object, count);
123    }
124
125    @Override
126    public int setCount(final E object, final int count) {
127        validate(object);
128        return decorated().setCount(object, count);
129    }
130
131    @Override
132    public Set<E> uniqueSet() {
133        return decorated().uniqueSet();
134    }
135
136}