Logo
Distributed Genetic Programming Framework
print print

File org.sfc.collections.CompoundIterator.java

Here you can find all the information about the file org.sfc.collections.CompoundIterator.java. You may explore it here or download it onto your local disk.
/*
 * Copyright (c) 2006 Thomas Weise
 * 
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2006-06-14 10:17:32
 * Original Filename: org.sfc.collections.CompoundIterator.java
 * Version          : 1.0.0
 * Last modification: 2006-06-14
 *                by: Thomas Weise
 * 
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *                    
 * Warranty         : This software is provided "as is" without any
 *                    warranty; without even the implied warranty of
 *                    merchantability or fitness for a particular purpose.
 *                    See the Gnu Lesser General Public License for more
 *                    details.
 */

 
package org.sfc.collections;

import java.util.Enumeration;
import java.util.Iterator;
import java.util.NoSuchElementException;

import org.sfc.utils.Typesafe;


/**
 * A compound iterator may consist of multiple sub-iterators or elements.
 * @param <Type>  The type of items to iterate over.
 *
 * @author Thomas Weise
 */

public final class CompoundIterator<Type> extends IteratorBase<Type>
  {
/**
 * The internal objects.
 */

  private Object[]  m_obj;
/**
 * The count of objects.
 */

  private int       m_cnt   ;
/**
 * The index.
 */

  private int       m_index ;
  
/**
 * Create a new compound iterator.
 */

  public  CompoundIterator()
    {
    super();
    this.m_obj = new Object[4];
    }
  
/**
 * Add an object to the compound iterator.
 * @param p_o The object to be added.
 */

  private final void do_add (final Object p_o)
    {
    int       l_c;
    Object[]  l_o;
    
    l_o = this.m_obj;
    l_c = this.m_cnt;
    
    if(l_c >= l_o.length)
      {
      l_o = new Object[l_c << 1];
      System.arraycopy(this.m_obj, 0, l_o, 0, l_c);
      this.m_obj = l_o;
      }
    l_o[l_c] = p_o;
    this.m_cnt = (l_c+1);
      
    }
  
/**
 * Add a new sub-iterator to this compound iterator.
 * @param p_iter The iterator to be added.
 */

  public  final void  add (final Iterator<Type> p_iter)
    {
    if(p_iter.hasNext()) this.do_add(p_iter);
    }
  
/**
 * Add a new sub-enumeration to this compound iterator.
 * @param p_enum The enumeration to be added.
 */

  public  final void  add (final Enumeration<Type> p_enum)
    {
    if(p_enum.hasMoreElements()) this.do_add(p_enum);
    }
  
/**
 * Advance one step in the iteration.
 * @return <tt>true</tt> if the iterator has more elements.
 */

  private final boolean advance()
    {
    Object   l_c;
    int      l_i, l_m;
    Object[] l_o;
        
    l_m = this.m_cnt;
    l_o = this.m_obj;    
    for(l_i = this.m_index; l_i < l_m; l_i++)        
      {
      if((((l_c = l_o[l_i]) instanceof Iterator) &&
             (((Iterator)l_c).hasNext())) ||
             ((Enumeration)l_c).hasMoreElements())
        {
        this.m_index = l_i;
        return true;
        }
      }
    
    this.m_index   = l_m;
    return false;
    }
  
/**
 * Returns <tt>true</tt> if the iteration has more elements. (In other
 * words, returns <tt>true</tt> if <tt>next</tt> would return an element
 * rather than throwing an exception.)
 *
 * @return <tt>true</tt> if the iterator has more elements.
 */

  public  final boolean hasNext()
    {
    return advance();
    }

/**
 * Returns the next element in the iteration.  Calling this method
 * repeatedly until the {@link #hasNext()} method returns false will
 * return each element in the underlying collection exactly once.
 *
 * @return the next element in the iteration.
 * @exception NoSuchElementException iteration has no more elements.
 */

  public  final Type  next()
    {
    Object l_o;
    
    if(this.advance())
      {
      l_o = this.m_obj[this.m_index];
      if(l_o instanceof Iterator)
        {
        return Typesafe.cast(((Iterator)l_o).next());
        }
      return Typesafe.cast(((Enumeration)l_o).nextElement());
      }
    
    throw new NoSuchElementException();
    }

/**
 * 
 * Removes from the underlying collection the last element returned by the
 * iterator (optional operation).  This method can be called only once per
 * call to <tt>next</tt>.  The behavior of an iterator is unspecified if
 * the underlying collection is modified while the iteration is in
 * progress in any way other than by calling this method.
 *
 * @exception UnsupportedOperationException if the <tt>remove</tt>
 *      operation is not supported by this Iterator.
 
 * @exception IllegalStateException if the <tt>next</tt> method has not
 *      yet been called, or the <tt>remove</tt> method has already
 *      been called after the last call to the <tt>next</tt>
 *      method.
 */

  @Override
  public  final void remove()
    {
    Object l_o;
    int    l_c;
    
    l_c = this.m_index;
    if(l_c < this.m_cnt)
      {
      l_o = this.m_obj[l_c];
      if(l_o instanceof Iterator)
        {
        ((Iterator)l_o).remove();
        }
      throw new UnsupportedOperationException();
      }
    throw new IllegalStateException();
    }
  }

File Information:

file name:CompoundIterator.java
package:org.sfc.collections
qualified name:org.sfc.collections.CompoundIterator.java
file type:Java Source File
download location:download http://dgpf.sourceforge.net/source/org/sfc/collections/CompoundIterator.java
size:5.461 KB (5593 B)
uploaded: 2018-01-07 12:03:36 GMT+0000
last update: 2006-06-14 08:43:48 GMT+0000
last access: 2018-04-21 07:47:27 GMT+0000

statistics online since 2006-01-02.   RSS Feed
Contact us by sending an email to tweise@gmx.de to receive further information, to report errors, or to join our project.
All content on this site (http://dgpf.sourceforge.net/) is LGPL-licensed.
http://dgpf.sourceforge.net/scripts/source/source.php last modified at 2018-01-07 12:03:34 GMT+0000 served at 2018-04-21 07:47:27 GMT+0000.
Valid CSS Valid XHTML 1.1
Valid RSS SourceForge.net Logo