/*
    * 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.collection;
  
  import java.util.Collection;
  import java.util.Iterator;
  import java.util.Objects;
  import java.util.function.Predicate;
  
  import org.apache.commons.collections4.BoundedCollection;
  import org.apache.commons.collections4.Unmodifiable;
  import org.apache.commons.collections4.iterators.UnmodifiableIterator;
  
  /**
   * {@link UnmodifiableBoundedCollection} decorates another
   * {@link BoundedCollection} to ensure it can't be altered.
   * <p>
   * If a BoundedCollection is first wrapped in some other collection decorator,
   * such as synchronized or predicated, the BoundedCollection methods are no
   * longer accessible.
   * The factory on this class will attempt to retrieve the bounded nature by
   * examining the package scope variables.
   * </p>
   * <p>
   * This class is Serializable from Commons Collections 3.1.
   * </p>
   * <p>
   * Attempts to modify it will result in an UnsupportedOperationException.
   * </p>
   *
   * @param <E> The type of elements in this collection.
   * @since 3.0
   */
  public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDecorator<E>
          implements BoundedCollection<E>, Unmodifiable {
  
      /** Serialization version */
      private static final long serialVersionUID = -7112672385450340330L;
  
      /**
       * Creates an unmodifiable bounded collection.
       *
       * @param <E> The type of the elements in the collection.
       * @param coll  The {@code BoundedCollection} to decorate, must not be null.
       * @return A new unmodifiable bounded collection.
       * @throws NullPointerException if {@code coll} is {@code null}.
       * @since 4.0
       */
      public static <E> BoundedCollection<E> unmodifiableBoundedCollection(final BoundedCollection<? extends E> coll) {
          if (coll instanceof Unmodifiable) {
              @SuppressWarnings("unchecked") // safe to upcast
              final BoundedCollection<E> tmpColl = (BoundedCollection<E>) coll;
              return tmpColl;
          }
          return new UnmodifiableBoundedCollection<>(coll);
      }
  
      /**
       * Creates an unmodifiable bounded collection.
       * <p>
       * This method is capable of drilling down through up to 1000 other decorators
       * to find a suitable BoundedCollection.
       * </p>
       *
       * @param <E> The type of the elements in the collection.
       * @param collection  The {@code BoundedCollection} to decorate, must not be null.
       * @return A new unmodifiable bounded collection.
       * @throws NullPointerException if coll is null.
       * @throws IllegalArgumentException if coll is not a {@code BoundedCollection}.
       * @since 4.0
       */
      @SuppressWarnings("unchecked")
      public static <E> BoundedCollection<E> unmodifiableBoundedCollection(Collection<? extends E> collection) {
          Objects.requireNonNull(collection, "collection");
  
          // handle decorators
          for (int i = 0; i < 1000; i++) {  // counter to prevent infinite looping
              if (collection instanceof BoundedCollection) {
                  break;  // normal loop exit
              }
              if (collection instanceof AbstractCollectionDecorator) {
                  collection = ((AbstractCollectionDecorator<E>) collection).decorated();
              } else if (collection instanceof SynchronizedCollection) {
                  collection = ((SynchronizedCollection<E>) collection).decorated();
              }
         }
 
         if (!(collection instanceof BoundedCollection)) {
             throw new IllegalArgumentException("Collection is not a bounded collection.");
         }
         return new UnmodifiableBoundedCollection<>((BoundedCollection<E>) collection);
     }
 
     /**
      * Constructs and wraps (not copies).
      *
      * @param coll  The collection to decorate, must not be null.
      * @throws NullPointerException if coll is null.
      */
     @SuppressWarnings("unchecked") // safe to upcast
     private UnmodifiableBoundedCollection(final BoundedCollection<? extends E> coll) {
         super((BoundedCollection<E>) coll);
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param object Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public boolean add(final E object) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param coll Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public boolean addAll(final Collection<? extends E> coll) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public void clear() {
         throw new UnsupportedOperationException();
     }
 
     @Override
     protected BoundedCollection<E> decorated() {
         return (BoundedCollection<E>) super.decorated();
     }
 
     @Override
     public boolean isFull() {
         return decorated().isFull();
     }
 
     @Override
     public Iterator<E> iterator() {
         return UnmodifiableIterator.unmodifiableIterator(decorated().iterator());
     }
 
     @Override
     public int maxSize() {
         return decorated().maxSize();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param object Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public boolean remove(final Object object) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param coll Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public boolean removeAll(final Collection<?> coll) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param filter Ignored.
      * @throws UnsupportedOperationException Always thrown.
      * @since 4.4
      */
     @Override
     public boolean removeIf(final Predicate<? super E> filter) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Always throws {@link UnsupportedOperationException}.
      *
      * @param Ignored.
      * @throws UnsupportedOperationException Always thrown.
      */
     @Override
     public boolean retainAll(final Collection<?> coll) {
         throw new UnsupportedOperationException();
     }
 }