/*
    * 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.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.util.HashMap;
  
  import org.apache.commons.collections4.BoundedMap;
  import org.apache.commons.collections4.KeyValue;
  import org.apache.commons.collections4.OrderedMap;
  import org.junit.jupiter.api.Test;
  
  /**
   * JUnit tests.
   */
  public class SingletonMapTest<K, V> extends AbstractOrderedMapTest<K, V> {
  
      private static final Integer ONE = Integer.valueOf(1);
      private static final Integer TWO = Integer.valueOf(2);
      private static final String TEN = "10";
  
      public SingletonMapTest() {
          super(SingletonMapTest.class.getSimpleName());
      }
  
      @Override
      public String getCompatibilityVersion() {
          return "4";
      }
  
      @Override
      @SuppressWarnings("unchecked")
      public V[] getNewSampleValues() {
          return (V[]) new Object[] { TEN };
      }
  
      @Override
      @SuppressWarnings("unchecked")
      public K[] getSampleKeys() {
          return (K[]) new Object[] { ONE };
      }
  
      @Override
      @SuppressWarnings("unchecked")
      public V[] getSampleValues() {
          return (V[]) new Object[] { TWO };
      }
  
      @Override
      public String[] ignoredTests() {
          // the ridiculous map above still doesn't pass these tests
          // but it's not relevant, so we ignore them
          return new String[] {
              "SingletonMapTest.bulkTestMapIterator.testEmptyMapIterator",
              "SingletonMapTest.bulkTestOrderedMapIterator.testEmptyMapIterator",
          };
      }
  
      @Override
      public boolean isPutAddSupported() {
          return false;
      }
  
      @Override
      public boolean isRemoveSupported() {
          return false;
      }
  
      @Override
      @SuppressWarnings("unchecked")
      public SingletonMap<K, V> makeFullMap() {
          return new SingletonMap<>((K) ONE, (V) TWO);
      }
  
      @Override
      public OrderedMap<K, V> makeObject() {
          // need an empty singleton map, but that's not possible
          // use a ridiculous fake instead to make the tests pass
          return UnmodifiableOrderedMap.unmodifiableOrderedMap(ListOrderedMap.listOrderedMap(new HashMap<>()));
      }
  
      @Test
      public void testBoundedMap() {
         final SingletonMap<K, V> map = makeFullMap();
         assertEquals(1, map.size());
         assertTrue(map.isFull());
         assertEquals(1, map.maxSize());
         assertTrue(map instanceof BoundedMap);
     }
 
     @Test
     public void testClone() {
         final SingletonMap<K, V> map = makeFullMap();
         assertEquals(1, map.size());
         final SingletonMap<K, V> cloned = map.clone();
         assertEquals(1, cloned.size());
         assertTrue(cloned.containsKey(ONE));
         assertTrue(cloned.containsValue(TWO));
     }
 
 //    public BulkTest bulkTestMapIterator() {
 //        return new TestFlatMapIterator();
 //    }
 //
 //    public class TestFlatMapIterator extends AbstractTestOrderedMapIterator {
 //        public TestFlatMapIterator() {
 //            super("TestFlatMapIterator");
 //        }
 //
 //        public Object[] addSetValues() {
 //            return TestSingletonMap.this.getNewSampleValues();
 //        }
 //
 //        public boolean supportsRemove() {
 //            return TestSingletonMap.this.isRemoveSupported();
 //        }
 //
 //        public boolean supportsSetValue() {
 //            return TestSingletonMap.this.isSetValueSupported();
 //        }
 //
 //        public MapIterator makeEmptyMapIterator() {
 //            resetEmpty();
 //            return ((Flat3Map) TestSingletonMap.this.map).mapIterator();
 //        }
 //
 //        public MapIterator makeFullMapIterator() {
 //            resetFull();
 //            return ((Flat3Map) TestSingletonMap.this.map).mapIterator();
 //        }
 //
 //        public Map getMap() {
 //            // assumes makeFullMapIterator() called first
 //            return TestSingletonMap.this.map;
 //        }
 //
 //        public Map getConfirmedMap() {
 //            // assumes makeFullMapIterator() called first
 //            return TestSingletonMap.this.confirmed;
 //        }
 //
 //        public void verify() {
 //            super.verify();
 //            TestSingletonMap.this.verify();
 //        }
 //    }
 
     @Test
     public void testKeyValue() {
         final SingletonMap<K, V> map = makeFullMap();
         assertEquals(1, map.size());
         assertEquals(ONE, map.getKey());
         assertEquals(TWO, map.getValue());
         assertTrue(map instanceof KeyValue);
     }
 
 //    public void testCreate() throws Exception {
 //        resetEmpty();
 //        writeExternalFormToDisk(
 //            (java.io.Serializable) map,
 //            "src/test/resources/data/test/SingletonMap.emptyCollection.version4.obj");
 //        resetFull();
 //        writeExternalFormToDisk(
 //            (java.io.Serializable) map,
 //            "src/test/resources/data/test/SingletonMap.fullCollection.version4.obj");
 //    }
 
 }