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

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

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
import java.util.Set;

import org.apache.commons.collections4.IterableMap;
import org.apache.commons.collections4.MapIterator;
import org.apache.commons.collections4.Unmodifiable;
import org.apache.commons.collections4.collection.UnmodifiableCollection;
import org.apache.commons.collections4.iterators.EntrySetMapIterator;
import org.apache.commons.collections4.iterators.UnmodifiableMapIterator;
import org.apache.commons.collections4.set.UnmodifiableSet;

/**
 * Decorates another Map to ensure it can't be altered.
 * 

* This class is Serializable from Commons Collections 3.1. *

* Attempts to modify it will result in an UnsupportedOperationException. * * @since 3.0 * @version $Id: UnmodifiableMap.java 1686855 2015-06-22 13:00:27Z tn $ */ public final class UnmodifiableMap extends AbstractMapDecorator implements Unmodifiable, Serializable { /** Serialization version */ private static final long serialVersionUID = 2737023427269031941L; /** * Factory method to create an unmodifiable map. * * @param the key type * @param the value type * @param map the map to decorate, must not be null * @return a new unmodifiable map * @throws NullPointerException if map is null * @since 4.0 */ public static Map unmodifiableMap(final Map map) { if (map instanceof Unmodifiable) { @SuppressWarnings("unchecked") // safe to upcast final Map tmpMap = (Map) map; return tmpMap; } return new UnmodifiableMap(map); } //----------------------------------------------------------------------- /** * Constructor that wraps (not copies). * * @param map the map to decorate, must not be null * @throws NullPointerException if map is null */ @SuppressWarnings("unchecked") // safe to upcast private UnmodifiableMap(final Map map) { super((Map) map); } //----------------------------------------------------------------------- /** * Write the map out using a custom routine. * * @param out the output stream * @throws IOException * @since 3.1 */ private void writeObject(final ObjectOutputStream out) throws IOException { out.defaultWriteObject(); out.writeObject(map); } /** * Read the map in using a custom routine. * * @param in the input stream * @throws IOException * @throws ClassNotFoundException * @since 3.1 */ @SuppressWarnings("unchecked") private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); map = (Map) in.readObject(); } //----------------------------------------------------------------------- @Override public void clear() { throw new UnsupportedOperationException(); } @Override public V put(final K key, final V value) { throw new UnsupportedOperationException(); } @Override public void putAll(final Map mapToCopy) { throw new UnsupportedOperationException(); } @Override public V remove(final Object key) { throw new UnsupportedOperationException(); } @Override public MapIterator mapIterator() { if (map instanceof IterableMap) { final MapIterator it = ((IterableMap) map).mapIterator(); return UnmodifiableMapIterator.unmodifiableMapIterator(it); } final MapIterator it = new EntrySetMapIterator(map); return UnmodifiableMapIterator.unmodifiableMapIterator(it); } @Override public Set> entrySet() { final Set> set = super.entrySet(); return UnmodifiableEntrySet.unmodifiableEntrySet(set); } @Override public Set keySet() { final Set set = super.keySet(); return UnmodifiableSet.unmodifiableSet(set); } @Override public Collection values() { final Collection coll = super.values(); return UnmodifiableCollection.unmodifiableCollection(coll); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy