Можем ли мы написать собственный итератор на Java?

104

Если у меня есть список, содержащий, [alice, bob, abigail, charlie]и я хочу написать итератор, который бы перебирал элементы, начинающиеся с 'a', могу ли я написать свой собственный? Как я могу это сделать ?

Феникс
источник
4
Ты можешь. Вы должны реализовать интерфейс Iterator.
gd1 01
конечно, это просто нормальный интерфейс. Проксирование java.util для JDO impl. включает в себя довольно много настраиваемых итераторов.
bestsss
codereview.stackexchange.com/questions/48109/…
Ciro Santilli 郝海东 冠状 病 六四 事件 法轮功

Ответы:

48

Конечно. Итератор - это просто реализация java.util.Iteratorинтерфейса. Если вы используете существующий итерационный объект (скажем, a LinkedList) из java.util, вам необходимо либо создать подкласс и переопределить его iteratorфункцию, чтобы вы вернули свою собственную, либо предоставить средство обертывания стандартного итератора в вашем специальном Iteratorэкземпляре (который имеет преимущество более широкого использования) и т. д.

TJ Crowder
источник
8
хороший ответ .... +1 Однако вы не обязаны создавать подкласс LinkedList. Вы можете написать CustomIterator, экземпляр которого создается с помощью нового CustomIterator (somelist), поскольку интерфейсы ничего не говорят о конструкторах.
gd1 01
1
@Giacomo: Это то, что я имел в виду, говоря «... или предоставить средство обертывания стандартного итератора в вашем особом Iteratorэкземпляре ...» (и спасибо). :-)
TJ Crowder
197

Лучший вариант многократного использования - реализовать интерфейс 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».

Вы можете просто создать анонимный экземпляр итератора без создания расширяющего Iterator и воспользоваться значением currentSize для проверки того, где вы можете перемещаться по массиву (допустим, вы создали массив с емкостью 10, но у вас есть только 2 элементы в 0 и 1). У экземпляра будет счетчик владельца, где он находится, и все, что вам нужно сделать, это поиграть с hasNext (), который проверяет, не является ли текущее значение нулевым, и 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 .

Теперь, чтобы получить эффект того, что вам нужно, я думаю, вам нужно включить концепцию фильтра в итератор ... Поскольку итератор зависит от следующих значений, было бы трудно вернуть true в hasNext (), а затем отфильтруйте реализацию next () со значением, которое, например, не начинается с символа "a". Я думаю, вам нужно поиграть со вторичным Interator на основе отфильтрованного списка со значениями с данным фильтром.

Марчелло де Салес
источник
14
for instanceэто каламбур?
n611x007 05
4
Еще 30 человек не подумали, что это каламбур :)
Марчелло де Сэйлз
2
Рекомендуется генерировать исключение неподдерживаемой операции из реализованных нами методов. Я думаю, что было бы неплохо выбросить исключение неподдерживаемой операции из метода remove ()!
даршан
2
Извините, @darshan, но это решение касается «как писать итераторы» ... Если бы акцент был на «написании идеально написанного кода», это было бы так!
Марчелло де Салес
непонятно, почему требуется проверка arrayList [currentIndex]! = null внутри hasNext (). может кто-нибудь объяснить.
Бхушан Кармаркар
12

Хороший пример для Iterable для вычисления факториала

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);

Пользовательский Iterable класс

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);
    }

}

Пользовательский класс Iterator

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); 
        }
    }
}

Пользовательский класс Iterator

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

Вы можете реализовать свой собственный Итератор. Ваш итератор может быть сконструирован так, чтобы обернуть итератор, возвращаемый List, или вы можете оставить курсор и использовать метод List get (int index). Вам просто нужно добавить логику в метод next вашего Iterator И метод 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исключение.
ападана
источник