/*
    * 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.directory.api.ldap.model.cursor;
  
  
  import java.io.IOException;
  import java.util.Iterator;
  
  import org.apache.directory.api.i18n.I18n;
  
  
  /**
   * Simple class that contains often used Cursor code.
   *
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   * @param <E> The type of element on which this cursor will iterate
   */
  public abstract class AbstractCursor<E> implements Cursor<E>
  {
      /** The default associated monitor */
      private ClosureMonitor monitor = new DefaultClosureMonitor();
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void setClosureMonitor( ClosureMonitor monitor )
      {
          if ( monitor == null )
          {
              throw new IllegalArgumentException( I18n.err( I18n.ERR_13101_MONITOR ) );
          }
  
          this.monitor = monitor;
      }
  
  
      /**
       * Check that the cursor is not closed before executing an operation.
       * 
       * @throws CursorClosedException If there is a problem during the check
       */
      public final void checkNotClosed() throws CursorClosedException
      {
          monitor.checkNotClosed();
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public boolean isClosed()
      {
          return monitor.isClosed();
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void close( Exception cause ) throws IOException
      {
          monitor.close( cause );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void close() throws IOException
      {
          monitor.close();
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
     public Iterator<E> iterator()
     {
         return new CursorIterator<>( this );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean isAfterLast()
     {
         throw new UnsupportedOperationException( I18n.err( I18n.ERR_13102_UNSUPPORTED_OPERATION, getClass().getName()
             .concat( "." ).concat( "isAfterLast()" ) ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean isBeforeFirst()
     {
         throw new UnsupportedOperationException( I18n.err( I18n.ERR_13102_UNSUPPORTED_OPERATION, getClass().getName()
             .concat( "." ).concat( "isBeforeFirst()" ) ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean isFirst()
     {
         throw new UnsupportedOperationException( I18n.err( I18n.ERR_13102_UNSUPPORTED_OPERATION, getClass().getName()
             .concat( "." ).concat( "isFirst()" ) ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean isLast()
     {
         throw new UnsupportedOperationException( I18n.err( I18n.ERR_13102_UNSUPPORTED_OPERATION, getClass().getName()
             .concat( "." ).concat( "isLast()" ) ) );
     }
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String toString( String tabs )
     {
         return tabs;
     }
 }