/*
    * 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 static org.junit.jupiter.api.Assertions.assertSame;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.util.HashMap;
  
  import org.apache.commons.collections4.OrderedMap;
  import org.apache.commons.collections4.Unmodifiable;
  import org.junit.jupiter.api.Test;
  
  /**
   * Extension of {@link AbstractOrderedMapTest} for exercising the
   * {@link UnmodifiableOrderedMap} implementation.
   */
  public class UnmodifiableOrderedMapTest<K, V> extends AbstractOrderedMapTest<K, V> {
  
      public UnmodifiableOrderedMapTest() {
          super(UnmodifiableOrderedMapTest.class.getSimpleName());
      }
  
      @Override
      public String getCompatibilityVersion() {
          return "4";
      }
  
      @Override
      public boolean isPutAddSupported() {
          return false;
      }
  
      @Override
      public boolean isPutChangeSupported() {
          return false;
      }
  
      @Override
      public boolean isRemoveSupported() {
          return false;
      }
  
      @Override
      public OrderedMap<K, V> makeFullMap() {
          final OrderedMap<K, V> m = ListOrderedMap.listOrderedMap(new HashMap<>());
          addSampleMappings(m);
          return UnmodifiableOrderedMap.unmodifiableOrderedMap(m);
      }
  
      @Override
      public OrderedMap<K, V> makeObject() {
          return UnmodifiableOrderedMap.unmodifiableOrderedMap(ListOrderedMap.listOrderedMap(new HashMap<>()));
      }
  
      @Test
      public void testDecorateFactory() {
          final OrderedMap<K, V> map = makeFullMap();
          assertSame(map, UnmodifiableOrderedMap.unmodifiableOrderedMap(map));
  
          assertThrows(NullPointerException.class, () -> UnmodifiableOrderedMap.unmodifiableOrderedMap(null));
      }
  
      @Test
      public void testUnmodifiable() {
          assertTrue(makeObject() instanceof Unmodifiable);
          assertTrue(makeFullMap() instanceof Unmodifiable);
      }
  
  //    public void testCreate() throws Exception {
  //        resetEmpty();
  //        writeExternalFormToDisk(
  //            (java.io.Serializable) map,
  //            "src/test/resources/data/test/UnmodifiableOrderedMap.emptyCollection.version4.obj");
  //        resetFull();
  //        writeExternalFormToDisk(
  //            (java.io.Serializable) map,
  //            "src/test/resources/data/test/UnmodifiableOrderedMap.fullCollection.version4.obj");
  //    }
  
  }