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

com.groupbyinc.common.apache.commons.collections4.multimap.UnmodifiableMultiValuedMap 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.multimap;

import java.util.Collection;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import org.apache.commons.collections4.MapIterator;
import org.apache.commons.collections4.MultiSet;
import org.apache.commons.collections4.MultiValuedMap;
import org.apache.commons.collections4.Unmodifiable;
import org.apache.commons.collections4.collection.UnmodifiableCollection;
import org.apache.commons.collections4.iterators.UnmodifiableMapIterator;
import org.apache.commons.collections4.map.UnmodifiableMap;
import org.apache.commons.collections4.multiset.UnmodifiableMultiSet;
import org.apache.commons.collections4.set.UnmodifiableSet;

/**
 * Decorates another {@link MultiValuedMap} to ensure it can't be altered.
 * 

* Attempts to modify it will result in an UnsupportedOperationException. * * @param the type of key elements * @param the type of value elements * * @since 4.1 * @version $Id: UnmodifiableMultiValuedMap.java 1685299 2015-06-13 18:27:11Z tn $ */ public final class UnmodifiableMultiValuedMap extends AbstractMultiValuedMapDecorator implements Unmodifiable { /** Serialization version */ private static final long serialVersionUID = 20150612L; /** * Factory method to create an unmodifiable MultiValuedMap. *

* If the map passed in is already unmodifiable, it is returned. * * @param the type of key elements * @param the type of value elements * @param map the map to decorate, may not be null * @return an unmodifiable MultiValuedMap * @throws NullPointerException if map is null */ @SuppressWarnings("unchecked") public static UnmodifiableMultiValuedMap unmodifiableMultiValuedMap( MultiValuedMap map) { if (map instanceof Unmodifiable) { return (UnmodifiableMultiValuedMap) map; } return new UnmodifiableMultiValuedMap(map); } /** * Constructor that wraps (not copies). * * @param map the MultiValuedMap to decorate, may not be null * @throws NullPointerException if the map is null */ @SuppressWarnings("unchecked") private UnmodifiableMultiValuedMap(final MultiValuedMap map) { super((MultiValuedMap) map); } @Override public Collection remove(final Object key) { throw new UnsupportedOperationException(); } @Override public boolean removeMapping(final Object key, final Object item) { throw new UnsupportedOperationException(); } @Override public void clear() { throw new UnsupportedOperationException(); } @Override public Collection get(final K key) { return UnmodifiableCollection.unmodifiableCollection(decorated().get(key)); } @Override public boolean put(final K key, final V value) { throw new UnsupportedOperationException(); } @Override public Set keySet() { return UnmodifiableSet.unmodifiableSet(decorated().keySet()); } @Override public Collection> entries() { return UnmodifiableCollection.unmodifiableCollection(decorated().entries()); } @Override public MultiSet keys() { return UnmodifiableMultiSet.unmodifiableMultiSet(decorated().keys()); } @Override public Collection values() { return UnmodifiableCollection.unmodifiableCollection(decorated().values()); } @Override public Map> asMap() { return UnmodifiableMap.unmodifiableMap(decorated().asMap()); } @Override public MapIterator mapIterator() { return UnmodifiableMapIterator.unmodifiableMapIterator(decorated().mapIterator()); } @Override public boolean putAll(final K key, final Iterable values) { throw new UnsupportedOperationException(); } @Override public boolean putAll(final Map map) { throw new UnsupportedOperationException(); } @Override public boolean putAll(final MultiValuedMap map) { throw new UnsupportedOperationException(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy