View Javadoc

1   /*
2    * $Id: ICardIterator.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3    * 
4    */
5   package org.rcfaces.core.component.iterator;
6   
7   import java.util.NoSuchElementException;
8   
9   import org.rcfaces.core.component.CardComponent;
10  
11  /**
12   * An iterator over a collection of CardComponents.
13   * 
14   * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
15   * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
16   */
17  public interface ICardIterator extends IComponentIterator {
18      /**
19       * Returns the next CardComponent in the iteration. Calling this method
20       * repeatedly until the {@link #hasNext()} method returns false will return
21       * each CardComponent in the underlying collection exactly once.
22       * 
23       * @return the next CardComponent in the iteration.
24       * @exception NoSuchElementException
25       *                iteration has no more CardComponents.
26       */
27      CardComponent next();
28  
29      /**
30       * Returns an array containing all of the CardComponents in this list in
31       * proper sequence.
32       * 
33       * @return an array containing all of the CardComponents in this list in
34       *         proper sequence.
35       */
36      CardComponent[] toArray();
37  }