Как я могу сделать свой класс итерабельным, чтобы я мог использовать синтаксис foreach?

У меня есть классы Book и BookList. BookList выглядит примерно так:

public class BookList 
{
    private final List<Book> bList = new ArrayList<Book>();

    public int size() { return bList.size(); }

    public boolean isEmpty() {  ... }

    public boolean contains(Book b) { ...  }

    public boolean add(Book b) { ...  }

    public boolean remove(Book b) {  .. } 

    public void clear() { ... }

    public Object get(int index) { ... }

}

В моем основном классе я хочу печатать названия книг с помощью a для каждого цикла:

for(Book b : bList)
{
    b.print();
}

Eclipse говорит:

Может только перебирать массив или экземпляр java.lang.Iterable

Как я могу заставить это работать?

Ответ 1

Вам необходимо реализовать интерфейс Iterable, что означает, что вам нужно реализовать метод iterator(). В вашем случае это может выглядеть примерно так:

public class BookList implements Iterable<Book> {
    private final List<Book> bList = new ArrayList<Book>();

    @Override
    public Iterator<Book> iterator() {
        return bList.iterator();
    }

    ...
}

Ответ 2

Внедрите интерфейс Iterable. Это означает, что вам нужно реализовать метод, который возвращает объект Iterator, который будет перебирать элементы BookList.

В этом случае ваш метод iterator() может просто вернуть результат вызова bList.iterator(). (Это приведет к тому, что for (Book b : somBookList) будет перебирать объекты Book в BookList.bList...)

В других случаях вам может понадобиться написать собственный класс реализации Iterator<T>, в комплекте с методами T next(), boolean hasNext() и remove(). Например, если вы хотите, чтобы внешний код не удалял элементы из BookList через ваш итератор, вы можете реализовать его следующим образом:

public class BookList implements Iterable<Book> {
    private final List<Book> bList = new ArrayList<Book>();
    //...
    @Override
    public Iterator<Book> iterator() {
        return new Iterator<Book> () {
            private final Iterator<Book> iter = bList.iterator();

            @Override
            public boolean hasNext() {
                return iter.hasNext();
            }

            @Override
            public Book next() {
                return iter.next();
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException("no changes allowed");
            }
        };
    }
}

Ответ 3

Здесь мы видим простую реализацию LinkedList с синтаксисом iterator и foreach

class LinkedList implements Iterable<LinkedList.Node>{
    private Node node;
    public void add(Object data){
        if(!Optional.ofNullable(node).isPresent()){
            node = new Node();
            node.setData(data);
        }else{
            Node node = new Node();
            node.setData(data);
            Node lastNode = getLastNode(this.node);
            lastNode.setNext(node);
        }
    }

    private Node getLastNode(Node node){
        if(node.getNext()==null){
            return node;
        }else{
            return getLastNode(node.getNext());
        }
    } 

    class Node{
        private Object data;
        private Node next;
        public Object getData() {
            return data;
        }
        public void setData(Object data) {
            this.data = data;
        }
        public Node getNext() {
            return next;
        }
        public void setNext(Node next) {
            this.next = next;
        }
    }

    public Iterator<Node> iterator() {
        return new NodeIterator();
    }

    class NodeIterator implements Iterator<Node>{
        private Node current;

        public boolean hasNext() {
            if(current == null){
                current = node;
                return Optional.ofNullable(current).isPresent();
            }else{
                current = current.next;
                return Optional.ofNullable(current).isPresent();
            }
        }

        public Node next() {
            return current;
        }
    }
}

public class LinkedListImpl {
    public static void main(String[] args) {
        LinkedList linkedList = new LinkedList();
        linkedList.add("data1");
        linkedList.add("data2");
        linkedList.add("data3");
        for(LinkedList.Node node: linkedList){
            System.out.println(node.getData());
        }
    }
}

Ответ 4

Более конкретно о том, как "реализовать интерфейс Iterable":

public class BookList implements Iterable<Book>
{
    private final List<Book> bList = new ArrayList<Book>();

    ... 

    @Override
    public Iterator<Book> iterator()
    {
        return bList.iterator();
    }
}

Ответ 5

Для создания итерации класса вам необходимо реализовать интерфейс Iterable.

a) Объявите класс ниже

public class BookList implements Iterable<Book>

b) Переопределить метод iterator()

Подробнее. Надеюсь, это поможет вам.