/*
    * 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
    *
    *      https://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.bidimap;
  
  import java.util.Map;
  import java.util.Set;
  
  import org.apache.commons.collections4.OrderedBidiMap;
  import org.apache.commons.collections4.OrderedMapIterator;
  import org.apache.commons.collections4.Unmodifiable;
  import org.apache.commons.collections4.iterators.UnmodifiableOrderedMapIterator;
  import org.apache.commons.collections4.map.UnmodifiableEntrySet;
  import org.apache.commons.collections4.set.UnmodifiableSet;
  
  /**
   * Decorates another {@link OrderedBidiMap} to ensure it can't be altered.
   * <p>
   * Attempts to modify it will result in an UnsupportedOperationException.
   * </p>
   *
   * @param <K> The type of the keys in this map
   * @param <V> The type of the values in this map
   * @since 3.0
   */
  public final class UnmodifiableOrderedBidiMap<K, V>
          extends AbstractOrderedBidiMapDecorator<K, V> implements Unmodifiable {
  
      /**
       * Factory method to create an unmodifiable map.
       * <p>
       * If the map passed in is already unmodifiable, it is returned.
       *
       * @param <K> The key type
       * @param <V> The value type
       * @param map  The map to decorate, must not be null
       * @return An unmodifiable OrderedBidiMap
       * @throws NullPointerException if map is null
       * @since 4.0
       */
      public static <K, V> OrderedBidiMap<K, V> unmodifiableOrderedBidiMap(
              final OrderedBidiMap<? extends K, ? extends V> map) {
          if (map instanceof Unmodifiable) {
              @SuppressWarnings("unchecked") // safe to upcast
              final OrderedBidiMap<K, V> tmpMap = (OrderedBidiMap<K, V>) map;
              return tmpMap;
          }
          return new UnmodifiableOrderedBidiMap<>(map);
      }
  
      /** The inverse unmodifiable map */
      private UnmodifiableOrderedBidiMap<V, K> inverse;
  
      /**
       * 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 UnmodifiableOrderedBidiMap(final OrderedBidiMap<? extends K, ? extends V> map) {
          super((OrderedBidiMap<K, V>) map);
      }
  
      /**
       * Always throws {@link UnsupportedOperationException}.
       *
       * @throws UnsupportedOperationException Always thrown.
       */
      @Override
      public void clear() {
          throw new UnsupportedOperationException();
      }
  
      @Override
      public Set<Map.Entry<K, V>> entrySet() {
          final Set<Map.Entry<K, V>> set = super.entrySet();
          return UnmodifiableEntrySet.unmodifiableEntrySet(set);
      }
  
      @Override
      public OrderedBidiMap<V, K> inverseBidiMap() {
          return inverseOrderedBidiMap();
      }
  
      /**
      * Gets an unmodifiable view of this map where the keys and values are reversed.
      *
      * @return An inverted unmodifiable bidirectional map
      */
     public OrderedBidiMap<V, K> inverseOrderedBidiMap() {
         if (inverse == null) {
             inverse = new UnmodifiableOrderedBidiMap<>(decorated().inverseBidiMap());
             inverse.inverse = this;
         }
         return inverse;
     }
 
     @Override
     public Set<K> keySet() {
         final Set<K> set = super.keySet();
         return UnmodifiableSet.unmodifiableSet(set);
     }
 
     @Override
     public OrderedMapIterator<K, V> mapIterator() {
         final OrderedMapIterator<K, V> it = decorated().mapIterator();
         return UnmodifiableOrderedMapIterator.unmodifiableOrderedMapIterator(it);
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param key Ignored.
      * @param value Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public V put(final K key, final V value) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param mapToCopy Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public void putAll(final Map<? extends K, ? extends V> mapToCopy) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param key Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public V remove(final Object key) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param value Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public K removeValue(final Object value) {
         throw new UnsupportedOperationException();
     }
 
     @Override
     public Set<V> values() {
         return UnmodifiableSet.unmodifiableSet(super.values());
     }
 
 }