- /*
- * Copyright 2003-2004 The Apache Software Foundation
- *
- * Licensed 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.collections.map;
-
- import java.io.IOException;
- import java.io.ObjectInputStream;
- import java.io.ObjectOutputStream;
- import java.io.Serializable;
- import java.util.Collection;
- import java.util.Comparator;
- import java.util.Map;
- import java.util.Set;
- import java.util.SortedMap;
-
- import org.apache.commons.collections.Unmodifiable;
- import org.apache.commons.collections.collection.UnmodifiableCollection;
- import org.apache.commons.collections.set.UnmodifiableSet;
-
- /**
- * Decorates another <code>SortedMap</code> to ensure it can't be altered.
- * <p>
- * This class is Serializable from Commons Collections 3.1.
- *
- * @since Commons Collections 3.0
- * @version $Revision: 1.7 $ $Date: 2004/04/09 10:46:32 $
- *
- * @author Stephen Colebourne
- */
- public final class UnmodifiableSortedMap
- extends AbstractSortedMapDecorator
- implements Unmodifiable, Serializable {
-
- /** Serialization version */
- private static final long serialVersionUID = 5805344239827376360L;
-
- /**
- * Factory method to create an unmodifiable sorted map.
- *
- * @param map the map to decorate, must not be null
- * @throws IllegalArgumentException if map is null
- */
- public static SortedMap decorate(SortedMap map) {
- if (map instanceof Unmodifiable) {
- return map;
- }
- return new UnmodifiableSortedMap(map);
- }
-
- //-----------------------------------------------------------------------
- /**
- * Constructor that wraps (not copies).
- *
- * @param map the map to decorate, must not be null
- * @throws IllegalArgumentException if map is null
- */
- private UnmodifiableSortedMap(SortedMap map) {
- super(map);
- }
-
- //-----------------------------------------------------------------------
- /**
- * Write the map out using a custom routine.
- *
- * @param out the output stream
- * @throws IOException
- * @since Commons Collections 3.1
- */
- private void writeObject(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 Commons Collections 3.1
- */
- private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
- in.defaultReadObject();
- map = (Map) in.readObject();
- }
-
- //-----------------------------------------------------------------------
- public void clear() {
- throw new UnsupportedOperationException();
- }
-
- public Object put(Object key, Object value) {
- throw new UnsupportedOperationException();
- }
-
- public void putAll(Map mapToCopy) {
- throw new UnsupportedOperationException();
- }
-
- public Object remove(Object key) {
- throw new UnsupportedOperationException();
- }
-
- public Set entrySet() {
- Set set = super.entrySet();
- return UnmodifiableEntrySet.decorate(set);
- }
-
- public Set keySet() {
- Set set = super.keySet();
- return UnmodifiableSet.decorate(set);
- }
-
- public Collection values() {
- Collection coll = super.values();
- return UnmodifiableCollection.decorate(coll);
- }
-
- //-----------------------------------------------------------------------
- public Object firstKey() {
- return getSortedMap().firstKey();
- }
-
- public Object lastKey() {
- return getSortedMap().lastKey();
- }
-
- public Comparator comparator() {
- return getSortedMap().comparator();
- }
-
- public SortedMap subMap(Object fromKey, Object toKey) {
- SortedMap map = getSortedMap().subMap(fromKey, toKey);
- return new UnmodifiableSortedMap(map);
- }
-
- public SortedMap headMap(Object toKey) {
- SortedMap map = getSortedMap().headMap(toKey);
- return new UnmodifiableSortedMap(map);
- }
-
- public SortedMap tailMap(Object fromKey) {
- SortedMap map = getSortedMap().tailMap(fromKey);
- return new UnmodifiableSortedMap(map);
- }
-
- }