1<?php
2
3/**
4 * Swift Mailer Iterator Interface
5 * Please read the LICENSE file
6 * @author Chris Corbyn <chris@w3style.co.uk>
7 * @package Swift
8 * @license GNU Lesser General Public License
9 */
10
11/**
12 * Swift Iterator Interface
13 * Provides the interface for iterators used for retrieving addresses in batch sends.
14 * @package Swift
15 * @author Chris Corbyn <chris@w3style.co.uk>
16 */
17interface Swift_Iterator
18{
19  /**
20   * Check if there is a value in the list after the current one.
21   * @return boolean
22   */
23  public function hasNext();
24  /**
25   * Move to the next position in the list if possible.
26   * @return boolean
27   */
28  public function next();
29  /**
30   * Seek to the given numeric index in the list of possible.
31   * @return boolean
32   */
33  public function seekTo($pos);
34  /**
35   * Get the value of the list at the current position.
36   * @return mixed
37   */
38  public function getValue();
39  /**
40   * Get the current list position.
41   * @return int
42   */
43  public function getPosition();
44}
45