/*

  * 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.collections.primitives;

 /**

  * An iterator over <code>boolean</code> values.

  *

  * @see org.apache.commons.collections.primitives.adapters.BooleanIteratorIterator

  * @see org.apache.commons.collections.primitives.adapters.IteratorBooleanIterator

  *

  * @since Commons Primitives 1.1

  * @version $Revision: 480460 $ $Date: 2006-11-29 03:14:21 -0500 (Wed, 29 Nov 2006) $

  */

 public interface BooleanIterator {

     /** 

      * Returns <code>true</code> iff I have more elements.  (In other words,

      * returns <code>true</code> iff a subsequent call to {@link #next next}

      * will return an element rather than throwing an exception.)

      * 

      * @return <code>true</code> iff I have more elements

      */

     boolean hasNext();

     /** 

      * Returns the next element in me.

      * 

      * @return the next element in me

      * @throws java.util.NoSuchElementException if there is no next element

      */          

     boolean next();

     /** 

      * Removes from my underlying collection the last element {@link #next

      * returned} by me (optional operation).

      * 

      * @throws UnsupportedOperationException if this operation is not supported

      * @throws IllegalStateException if {@link #next} has not yet been called,

      *         or {@link #remove} has already been called since the last call

      *         to {@link #next}.

      */          

     void remove();

 }