我们可以用Java编写自己的迭代器吗?


103

如果我有一个包含的列表,[alice, bob, abigail, charlie]并且想编写一个迭代器,以便对以'a'开头的元素进行迭代,那么我可以编写自己的迭代器吗?我怎样才能做到这一点 ?


4
您可以。您必须实现Iterator接口。
gd1 2011年

当然,这只是一个普通的界面。为JDO impl代理java.util。涉及很多自定义迭代器。
2011年

Answers:


48

当然。迭代器只是java.util.Iterator接口的实现。如果您使用的现有可迭代对象(例如LinkedListjava.util,则需要对其进行子类化并覆盖其iterator功能,以便返回自己的对象,或者提供一种在特殊Iterator实例中包装标准迭代器的方法(具有被更广泛使用的优势)等。


8
很好的答案...。+1但是,您不必强制继承LinkedList。您可以编写一个用新的CustomIterator(somelist)实例化的CustomIterator,因为接口对构造函数一无所知。
gd1 2011年

1
@Giacomo:我的意思是“ ...或提供一种在您的特殊Iterator实例中包装标准迭代器的方法...”(谢谢)。:-)
TJ Crowder

195

最好的可重用选项是实现Iterable接口并覆盖方法iterator()。

这是一个类似ArrayList的类的示例,该类实现了接口,在其中您重写了Iterator()方法。

import java.util.Iterator;

public class SOList<Type> implements Iterable<Type> {

    private Type[] arrayList;
    private int currentSize;

    public SOList(Type[] newArray) {
        this.arrayList = newArray;
        this.currentSize = arrayList.length;
    }

    @Override
    public Iterator<Type> iterator() {
        Iterator<Type> it = new Iterator<Type>() {

            private int currentIndex = 0;

            @Override
            public boolean hasNext() {
                return currentIndex < currentSize && arrayList[currentIndex] != null;
            }

            @Override
            public Type next() {
                return arrayList[currentIndex++];
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException();
            }
        };
        return it;
    }
}

此类使用以下方法实现Iterable接口 Generics。考虑到数组中有元素,您将能够获得Iterator的实例,例如,它是“ foreach”循环使用的所需实例。

您可以只创建迭代器的匿名实例,而无需创建扩展的迭代器,并利用currentSize的值来验证可以在数组上进行导航的位置(假设您创建的数组的容量为10,但是只有2个0和1处的元素)。该实例将拥有其所在位置的所有者计数器,您需要做的就是使用hasNext()来验证当前值是否不为null,以及使用next()来返回您的currentIndex实例。以下是使用此API的示例...

public static void main(String[] args) {
    // create an array of type Integer
    Integer[] numbers = new Integer[]{1, 2, 3, 4, 5};

    // create your list and hold the values.
    SOList<Integer> stackOverflowList = new SOList<Integer>(numbers);

    // Since our class SOList is an instance of Iterable, then we can use it on a foreach loop
    for(Integer num : stackOverflowList) {
        System.out.print(num);
    }

    // creating an array of Strings
    String[] languages = new String[]{"C", "C++", "Java", "Python", "Scala"};

    // create your list and hold the values using the same list implementation.
    SOList<String> languagesList = new SOList<String>(languages);

    System.out.println("");
    // Since our class SOList is an instance of Iterable, then we can use it on a foreach loop
    for(String lang : languagesList) {
        System.out.println(lang);
    }
}
// will print "12345
//C
//C++
//Java
//Python
//Scala

如果需要,还可以使用Iterator实例对其进行迭代:

// navigating the iterator
while (allNumbers.hasNext()) {
    Integer value = allNumbers.next();
    if (allNumbers.hasNext()) {
        System.out.print(value + ", ");
    } else {
        System.out.print(value);
    }
} 
// will print 1, 2, 3, 4, 5

foreach文档位于http://download.oracle.com/javase/1,5.0/docs/guide/language/foreach.html。您可以在我的个人练习中查看更完整的实现 google代码中

现在,要获得所需的效果,我认为您需要在Iterator中插入一个过滤器的概念...由于Iterator依赖于下一个值,因此很难在hasNext()上返回true,然后例如,使用不以字符“ a”开头的值过滤next()实现。我认为您需要根据具有给定过滤器值的过滤列表来处理辅助Interator。


14
for instance,是双关语吗?
n611x007 2013年

4
其他30个人认为这不是一个双关语:)
Marcello de Sales

2
最好从我们实现的方法中抛出不受支持的操作异常。我认为从remove()方法抛出不受支持的操作异常是个好主意!
darshan

2
对不起,@ darshan,但是此解决方案是关于“如何编写迭代器”的……如果重点是“编写完美编写的代码”,那就在那里!
Marcello de Sales

不清楚为什么在hasNext()中需要'arrayList [currentIndex]!= null'检查。有人可以解释一下吗?
Bhushan Karmarkar,

12

迭代计算阶乘的好例子

FactorialIterable fi = new FactorialIterable(10);
Iterator<Integer> iterator = fi.iterator();
while (iterator.hasNext()){
     System.out.println(iterator.next());
}

Java 1.8的短代码

new FactorialIterable(5).forEach(System.out::println);

自定义迭代类

public class FactorialIterable implements Iterable<Integer> {

    private final FactorialIterator factorialIterator;

    public FactorialIterable(Integer value) {
        factorialIterator = new FactorialIterator(value);
    }

    @Override
    public Iterator<Integer> iterator() {
        return factorialIterator;
    }

    @Override
    public void forEach(Consumer<? super Integer> action) {
        Objects.requireNonNull(action);
        Integer last = 0;
        for (Integer t : this) {
            last = t;
        }
        action.accept(last);
    }

}

自定义迭代器类

public class FactorialIterator implements Iterator<Integer> {

    private final Integer mNumber;
    private Integer mPosition;
    private Integer mFactorial;


    public FactorialIterator(Integer number) {
        this.mNumber = number;
        this.mPosition = 1;
        this.mFactorial = 1;
    }

    @Override
    public boolean hasNext() {
        return mPosition <= mNumber;
    }

    @Override
    public Integer next() {
        if (!hasNext())
            return 0;

        mFactorial = mFactorial * mPosition;

        mPosition++;

        return  mFactorial;
    }
}

8

这是编写迭代器的完整代码,以便迭代以'a'开头的元素:

import java.util.Iterator;

public class AppDemo {

    public static void main(String args[]) {

        Bag<String> bag1 = new Bag<>();

        bag1.add("alice");
        bag1.add("bob"); 
        bag1.add("abigail");
        bag1.add("charlie"); 

        for (Iterator<String> it1 = bag1.iterator(); it1.hasNext();) {

            String s = it1.next();
            if (s != null)
                System.out.println(s); 
        }
    }
}

自定义迭代器类

import java.util.ArrayList;
import java.util.Iterator;

public class Bag<T> {

    private ArrayList<T> data;

    public Bag() {

        data = new ArrayList<>();
    }

    public void add(T e) {

        data.add(e); 
    }

    public Iterator<T> iterator() {

        return new BagIterator();
    }

    public class BagIterator<T> implements Iterator<T> {

        private int index; 
        private String str;

        public BagIterator() {

            index = 0;
        }

        @Override
        public boolean hasNext() {

             return index < data.size();  
        }

        @Override
        public T next() {

            str = (String) data.get(index); 
            if (str.startsWith("a"))
                return (T) data.get(index++); 
            index++; 
            return null; 
        }
    } 
}

5

您可以实现自己的Iterator。您的迭代器可以构造为包装List返回的Iterator,或者可以保留光标并使用List的get(int index)方法。您只需要向Iterator的next方法和hasNext方法添加逻辑即可考虑您的过滤条件。您还必须确定迭代器是否支持删除操作。


1

这是问题的完整答案。

import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;

class ListIterator implements Iterator<String>{
    List<String> list;
    int pos = 0;

    public ListIterator(List<String> list) {
        this.list = list;
    }

    @Override
    public boolean hasNext() {
        while(pos < list.size()){
            if (list.get(pos).startsWith("a"))
                return true;
            pos++;
        }
        return false;

    }

    @Override
    public String next() {
        if (hasNext())
            return list.get(pos++);
        throw new NoSuchElementException();
    }
}

public class IteratorTest {

    public static void main(String[] args) {
        List<String> list = Arrays.asList("alice", "bob", "abigail", "charlie");
        ListIterator itr = new ListIterator(list);

        while(itr.hasNext())
            System.out.println(itr.next()); // prints alice, abigail
    }
}
  • ListIterator 是数组的迭代器,该数组返回以'a'开头的元素。
  • 无需实现Iterable接口。但这是可能的。
  • 无需一般地实现。
  • 它完全满足hasNext()和next()的合同。即,如果hasNext()表示仍有元素,则next()将返回这些元素。如果hasNext()不再显示任何元素,则返回有效的NoSuchElementException异常。
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.