/*
 * 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.SortedMap;
import java.util.TreeMap;

import org.apache.commons.collections4.Unmodifiable;

/**
 * Extension of {@link AbstractSortedMapTest} for exercising the
 * {@link UnmodifiableSortedMap} implementation.
 *
 * @since 3.0
 */
public class UnmodifiableSortedMapTest<K, V> extends AbstractSortedMapTest<K, V> {

    public UnmodifiableSortedMapTest(final String testName) {
        super(testName);
    }

    //-------------------------------------------------------------------

    @Override
    public SortedMap<K, V> makeObject() {
        return UnmodifiableSortedMap.unmodifiableSortedMap(new TreeMap<K, V>());
    }

    @Override
    public boolean isPutChangeSupported() {
        return false;
    }

    @Override
    public boolean isPutAddSupported() {
        return false;
    }

    @Override
    public boolean isRemoveSupported() {
        return false;
    }

    @Override
    public SortedMap<K, V> makeFullMap() {
        final SortedMap<K, V> m = new TreeMap<>();
        addSampleMappings(m);
        return UnmodifiableSortedMap.unmodifiableSortedMap(m);
    }

    //-----------------------------------------------------------------------

    public void testUnmodifiable() {
        assertTrue(makeObject() instanceof Unmodifiable);
        assertTrue(makeFullMap() instanceof Unmodifiable);
    }

    public void testDecorateFactory() {
        final SortedMap<K, V> map = makeFullMap();
        assertSame(map, UnmodifiableSortedMap.unmodifiableSortedMap(map));

        try {
            UnmodifiableSortedMap.unmodifiableSortedMap(null);
            fail();
        } catch (final NullPointerException ex) {}
    }

    //-----------------------------------------------------------------------

    public void testHeadMap() {
        final SortedMap<K, V> map = makeFullMap();
        final SortedMap<K, V> m = new TreeMap<>();
        // "again" is the first key of the map
        assertSame(m.isEmpty(), map.headMap((K) "again").isEmpty());
    }

    //-----------------------------------------------------------------------

    @Override
    public String getCompatibilityVersion() {
        return "4";
    }

//    public void testCreate() throws Exception {
//        resetEmpty();
//        writeExternalFormToDisk(
//            (java.io.Serializable) map,
//            "src/test/resources/data/test/UnmodifiableSortedMap.emptyCollection.version4.obj");
//        resetFull();
//        writeExternalFormToDisk(
//            (java.io.Serializable) map,
//            "src/test/resources/data/test/UnmodifiableSortedMap.fullCollection.version4.obj");
//    }

}

@@ -2837,24 +2837,1436 @@
 isEmpty());%0A
+        assertSame(18, map.size());%0A        // %22you%22 is the last key of the map%0A        assertSame(17, map.headMap((K) %22you%22).size());%0A        // %22we'll%22 is the before key of %22you%22%0A        assertSame(16, map.headMap((K) %22we'll%22).size());%0A    %7D%0A%0A    //-----------------------------------------------------------------------%0A%0A    public void testTailMap() %7B%0A        final SortedMap%3CK, V%3E map = makeFullMap();%0A%0A        assertSame(18, map.size());%0A        // %22you%22 is the last key of the map%0A        assertSame(1, map.tailMap((K) %22you%22).size());%0A        // %22we'll%22 is the before key of %22you%22%0A        assertSame(2, map.tailMap((K) %22we'll%22).size());%0A        // %22again%22 is the first key of the map%0A        assertSame(18, map.tailMap((K) %22again%22).size());%0A    %7D%0A%0A    //-----------------------------------------------------------------------%0A%0A    public void testSubMap() %7B%0A        final SortedMap%3CK, V%3E map = makeFullMap();%0A%0A        assertSame(18, map.size());%0A        // get the sub map from again to you(exclusive)%0A        assertSame(17, map.subMap((K) %22again%22, (K) %22you%22).size());%0A        // get the sub map from again to we'll(exclusive)%0A        assertSame(16, map.subMap((K) %22again%22, (K) %22we'll%22).size());%0A        // %22again%22 is the first key of the map%0A        assertSame(0, map.subMap((K) %22again%22, (K) %22again%22).size());%0A%0A        assertSame(map.headMap((K)%22you%22).size(), map.subMap((K) %22again%22, (K) %22you%22).size());%0A
     %7D%0A%0A    /

Test subMap and tailMap (#94)