4.8Iterator-Schnittstelle 
Die Iterator-Schnittstelle ist klein und schreibt drei Methoden vor, dazu kommt in Java 8 eine Default-Methode, die wir uns später anschauen.
boolean hasNext()
Liefert true, falls die Iteration weitere Elemente bietet.E next()
Liefert das nächste Element in der Aufzählung oder NoSuchElementException, wenn keine weiteren Elemente mehr vorhanden sind.void remove()
Entfernt das Element, das der Iterator zuletzt bei next() geliefert hat. Kann ein Iterator keine Elemente löschen, so löst er eine UnsupportedOperationException aus.
[zB]Beispiel
Da jede Collection eine Methode iterator() besitzt, lassen sich alle Elemente einer Sammlung wie folgt auf dem Bildschirm ausgeben:
Collections.addAll( set, "Horst", "Schlämmer", "Hape" , "Kerkeling" );
for ( Iterator<String> iter = set.iterator(); iter.hasNext(); )
System.out.println( iter.next() );
Das erweiterte for macht das Ablaufen aber noch einfacher, und der gleiche Iterator steckt dahinter.
4.8.1Der Iterator kann (eventuell auch) löschen
Die Schnittstelle Iterator bietet prinzipiell die Möglichkeit, das zuletzt aufgezählte Element aus dem zugrunde liegenden Container mit remove() zu entfernen. Vor dem Aufruf muss also next() das zu löschende Element als Ergebnis geliefert haben. Eine Enumeration kann die aufgezählte Datenstruktur grundsätzlich nicht verändern.
In der Dokumentation ist die Methode remove() als optional gekennzeichnet. Das heißt, dass ein konkreter Iterator kein remove() können muss – auch eine UnsupportedOperationException ist möglich. Das ist etwa dann der Fall, wenn ein Iterator von einer unveränderbaren Datenstruktur kommt.
[»]Hinweis
Warum es die Methode remove() im Iterator gibt, ist eine interessante Frage. Die Erklärung dafür: Der Iterator kennt die Stelle, an der sich die Daten befinden (eine Art Cursor). Darum können die Daten dort auch effizient und direkt gelöscht werden. Das erklärt jedoch nicht unbedingt, warum es keine Einfüge-Methode gibt. Ein allgemeiner Grund mag sein, dass bei vielen Container-Typen das Einfügen an einer bestimmten Stelle keinen Sinn ergibt, etwa bei einem sortierten NavigableSet oder einer NavigableMap. Dort ist die Einfügeposition durch die Sortierung vorgegeben oder belanglos (bzw. bei HashSet durch die interne Realisierung bestimmt), also kein Fall für einen Iterator. Dazu wirft das Einfügen weitere Fragen auf: vor oder nach dem zuletzt per next() gelieferten Element? Soll das neue Element mit aufgezählt werden oder nicht? Soll es auch dann nicht aufgezählt werden, wenn es in der Sortierung erst später an die Reihe käme? Eine Löschen-Methode ist problemloser und universell anwendbar.
4.8.2Operationen auf allen Elementen durchführen
Mit der in Java 8 neu eingeführten Default-Methode forEachRemaining(…) lässt sich Programmcode (genannt Konsument) für jedes (verbleibende) Element des Iterators aufrufen. Statt also von Hand in einer Schleife das Paar hashNext()/next() zu verwenden, läuft forEachRemaining(…) für uns den Iterator komplett ab. Verschiedene Implementierungen des Iterators können dabei frei machen, was sie wollen, etwa die Abarbeitung in einem Extra-Thread setzen.
default void forEachRemaining(Consumer<? super E> action)
4.8.3Einen Zufallszahlen-Iterator schreiben
Zur Übung wollen wir einen Iterator schreiben, der Zufallszahlen liefert. Der Konstruktor soll dazu die maximale Zufallszahl entgegennehmen (exklusiv), die Methode next() liefert anschließend immer die Zufallszahl und hasNext() immer true. Da auch remove() von der Schnittstelle Iterator vorgeschrieben ist, müssen wir die Methode implementieren, lösen jedoch eine Ausnahme aus, da es nichts zu löschen gibt.
Listing 4.24com/tutego/insel/util/RandomIterator.java
import java.util.*;
/**
* Iterator for pseudorandom numbers.
*/
public class RandomIterator implements Iterator<Integer> {
private final Random random = new Random();
private final int bound;
/**
* Initializes this iterator with a maximum value (exclusive) for
* pseudorandom numbers.
* @param bound Maximum (exclusive) pseudorandom
*/
public RandomIterator( int bound ) {
this.bound = bound;
}
/**
* Always true.
* @return {@code true}.
*/
@Override
public boolean hasNext() {
return true;
}
/**
* Returns a pseudorandom, uniformly distributed {@code Integer} value
* between 0 (inclusive) and the specified value (exclusive).
* @return Next pseudorandom.
*/
@Override
public Integer next() {
return random.nextInt( bound );
}
/**
* Not supported.
* @throws UnsupportedOperationException
*/
@Override
public void remove() {
throw new UnsupportedOperationException();
}
}
Ein Beispiel:
Listing 4.25com/tutego/insel/util/RandomIteratorDemo.java, main()
int dice1 = random.next();
int dice2 = random.next();
System.out.println( dice1 );
System.out.println( dice2 );
Als Übung kann jeder den Iterator so verändern, dass auch ein Startwert definiert werden kann (jetzt ist er 0).
4.8.4Iteratoren von Sammlungen, das erweiterte for und Iterable
Jede Collection wie ArrayList oder HashSet liefert mit iterator() einen Iterator.
extends Iterable<E>
Iterator<E> iterator()
Liefert den Iterator der Datenstruktur.
Collection erweitert eine Schnittstelle Iterable, die diese Methode auch vorschreibt. Iterable kam erst in Java 5 in die Bibliothek, und da gab es iterator() schon, sonst wäre die Methode in Collection nicht noch einmal nötig.
Iterator<T> iterator()
Liefert den Iterator für eine Sammlung.
Der typisierte Iterator
Von einer typisierten Collection liefert iterator() ebenfalls einen typisierten Iterator. Das heißt, die Datenstruktur überträgt den generischen Typ auf den Iterator. Nehmen wir eine mit String typisierte Sammlung an:
Ein Aufruf von c.iterator() liefert nun Iterator<String>, und beim Durchlaufen über den Iterator kann die explizite Typanpassung beim next() entfallen:
String s = i.next();
…
}
Iterator und erweitertes for
Stößt der Compiler auf ein erweitertes for, und erkennt er rechts vom Doppelpunkt den Typ Iterable, so erzeugt er Bytecode für eine Schleife, die den Iterator und seine bekannten Methoden hasNext() und next() nutzt. Nehmen wir eine statische Methode totalStringLength(List) an, die ermitteln soll, wie viele Zeichen alle Strings zusammen besitzen. Aus
int result = 0;
for ( String s : strings )
result += s.length();
return result;
}
erzeugt der Compiler selbstständig:
int result = 0;
for ( Iterator<String> iter = strings.iterator(); iter.hasNext(); )
result += iter.next().length();
return result;
}
Da die erweiterte Schleife das Ablaufen einer Datenstruktur vereinfacht, wird ein explizit ausprogrammierter Iterator selten benötigt. Doch der Iterator kann ein Element über die remove()-Methode des Iterators löschen, was über das erweiterte for nicht möglich ist.
Ein eigener Iterator und Iterable-Implementierung
Die Konzepte Iterator und Iterable müssen sauber getrennt werden: Ein Iterator ist das Objekt, das durch eine Datensammlung läuft, während ein Iterable das Objekt ist, das einen anderen Iterator liefert. Eine Klasse kann beide Schnittstellen implementieren, doch oft kommt das nicht vor. Für unser nächstes Beispiel ergibt das aber Sinn – es nutzt einem Iterator, der durch eine Sammlung läuft und immer dann, wenn er an das Ende kommt, wieder von vorne beginnt. Zunächst der Einsatz:
Listing 4.26com/tutego/insel/util/RotatingIteratorDemo.java, main()
for ( String s : new RotatingIterator<>( "Bohnen", "Eintopf" ) ) {
System.out.println( "Toll, heute gibt es " + s );
if ( i++ == 7 )
break;
}
Zur Implementierung:
Listing 4.27com/tutego/insel/util/RotatingIterator.java
import java.util.Arrays;
import java.util.Collection;
import java.util.ConcurrentModificationException;
import java.util.Iterator;
import java.util.NoSuchElementException;
/**
* An {@link Iterator} that goes over a given {@link Collection}
* but rolls back to the start when it reaches the end.
* If the underling {@link Collection} contains no elements the method
* {@link #hasNext()} will return {@code false}. Removing elements is
* supported if the Iterator of the underlying Collection
* supports {@link Iterator#remove()}. Iterating over the underling
* Collection and modifying it at the same time will probably result in a
* {@link ConcurrentModificationException}.
*/
public class RotatingIterator<E> implements Iterator<E>, Iterable<E> {
private final Collection<? extends E> collection;
private Iterator<? extends E> iterator;
public RotatingIterator( Collection<? extends E> collection ) {
if ( collection == null )
throw new IllegalArgumentException( "Collection darf nicht null sein" );
this.collection = collection;
iterator = collection.iterator();
}
public RotatingIterator( E... elements ) {
this( Arrays.asList( elements ) );
}
@Override
public boolean hasNext() {
return ! collection.isEmpty();
}
@Override
public E next() {
if ( ! hasNext() )
throw new NoSuchElementException( "Keine Elemente in der Collection" );
if ( ! iterator.hasNext() )
iterator = collection.iterator();
return iterator.next();
}
@Override
public void remove() {
iterator.remove();
}
@Override
public Iterator<E> iterator() {
return this;
}
}
4.8.5Fail-Fast-Iterator und die ConcurrentModificationException
Beackern zwei Programmstellen gleichzeitig eine Datenstruktur, so kann es zu Schwierigkeiten kommen, wenn sich die Datenstruktur strukturell verändert, also neue Elemente hinzukommen oder wegfallen. Probleme treten leicht auf, wenn ein Verweis auf die Datenstruktur im Programm an verschiedenen Stellen weitergegeben wird. Führt nun eine Stelle strukturelle Änderungen mit Methoden wie remove(…) oder add(…) durch und verändert sich damit die Größe der Liste, dann kann das zu Zugriffsfehlern führen, wenn die andere Stelle von der Änderung nichts mitbekommt.
Nehmen wir an, zwei Programmteile greifen auf eine gemeinsame Liste zurück. Ein Programmteil merkt sich eine Suchstelle und will anschließend auf das gefundene Element zurückgreifen. Zwischen diesen beiden Operationen verändert jedoch ein anderer Programmteil die Liste, und die Position des Elements verschiebt sich:
Listing 4.28com/tutego/insel/util/ConcurrentModification.java, main()
int posOfZippus = list.indexOf( "Zippus" );
System.out.println( list.get( posOfZippus ) ); // Zippus
list.add( 0, "Apulien" );
System.out.println( list.get( posOfZippus ) ); // Trullo
Nach dem Einfügen von "Apulien" ist posOfZippus also veraltet. Es wäre eine Hilfe, wenn get(…) die strukturelle Veränderung bemerken würde.
Beim Erfragen über Listen-Iteratoren ist das anders. Die Entwickler der Java-Bibliothek haben einen Entwurf gewählt, bei dem konfliktträchtige Änderungen über die Listen-Iteratoren auffallen und zu einer ConcurrentModificationException führen:
Listing 4.29com/tutego/insel/util/ConcurrentModificationExceptionDemo.java, main()
Iterator<String> iterator = list.iterator(); // modCount = 0, expectedModCount = 0
list.get( 0 ); // Anfragen ändert modCount nicht
list.add( "Entspannung" ); // modCount = 1, expectedModCount = 0
iterator.next(); // modCount != expectedModCount => CME
Das funktioniert so, dass sich die Liste die Anzahl struktureller Änderungen merkt – bei der Standardimplementierung vom JDK intern in der Variablen modCount. Der Iterator registriert also die Änderungen, da sich der modCount in der Zwischenzeit durch das add(…) verändert hat. Wird der Iterator initialisiert, erfragt er den modCount der Liste und speichert den Wert in expectedModCount. Jede strukturelle Änderung in der Liste führt zum Inkrement vom modCount. Wird später eine Operation über den Iterator durchgeführt, testet er, ob der gemerkte expectedModCount mit dem aktuellen modCount übereinstimmt. In unserem Fall tut er das nicht, denn add(…) ist eine strukturelle Änderung und modCount wird 1. Beim nachfolgenden next() kommt es zu einer ConcurrentModificationException.
CurrentModificationException vermeiden
Die CurrentModificationException lässt sich in der Regel durch Umbau des Programmcodes vermeiden. Rekapitulieren wir, woher die Ausnahme eigentlich kommt: Sie kommt vom parallelen Verändern, also dem Einfügen oder Löschen der Datenstruktur, während ein Lesedurchlauf über den Iterator stattfindet. Die Lösung besteht darin, die Veränderungen über den Iterator vorzunehmen, denn dieser besitzt Einfüge-/Löschoperationen. Der Standard-Iterator bietet nur remove(), doch der ListIterator bietet auch eine set(…) bzw. add(…)-Methode.
Beispiel: Die folgenden Zeilen sollen eine Datenstruktur result ablaufen und alle Personen rausschmeißen, die verrückt sind. Lösung eins führt zur CurrentModificationException:
if ( p.isWired() )
result.remove( p ); //
CurrentModificationExceptionÜbertragen wir das Löschen dem Iterator, funktioniert es:
if ( iterator.next().isWired() )
iterator.remove();
4.8.6Die Schnittstelle Enumerator *
Für Iteratoren deklariert die Java-Bibliothek zwei unterschiedliche Schnittstellen. Das hat historische Gründe: Die Schnittstelle Enumeration[ 51 ](Nicht Enumerable!) gibt es seit den ersten Java-Tagen; die Schnittstelle Iterator gibt es seit Java 1.2, seit der Collection-API. Der Typ Iterator ist jedoch deutlich weiter verbreitet. Die Namen der Operationen unterscheiden sich in den Schnittstellen ein wenig und sind beim neuen Iterator kürzer.
Hast du mehr? | Gib mir das Nächste! | |
|---|---|---|
Iterator | hasNext() | next() |
Enumeration | hasMoreElements() | nextElement() |
Tabelle 4.4Methoden von Iterator und Enumeration
boolean hasMoreElements()
Testet, ob ein weiteres Element aufgezählt werden kann.E nextElement()
Liefert das nächste Element der Enumeration zurück. Diese Methode kann später eine NoSuchElementException (eine RuntimeException) auslösen, wenn nextElement() aufgerufen und das Ergebnis false beim Aufruf von hasMoreElements() ignoriert wird.
Wie auch Iterable erweitert Enumeration keine weitere Schnittstelle.
Konvertieren von Enumeration, Iterator, Iterable *
Es gibt keine direkte Methode, die eine Enumeration in einen Iterator oder einen Iterator in eine Enumeration konvertiert. Nur über Umwege lässt sich das erreichen. Es helfen dabei zwei Methoden in der Utility-Klasse Collections:
static <T> Enumeration<T> enumeration(Collection<T> c)
static <T> ArrayList<T> list(Enumeration<T> e)
Die Methode enumeration() liefert zu einer Collection eine Aufzählung vom Typ Enumeration. (Für einen gewünschten Iterator ist keine Hilfsmethode nötig, da jede Collection die Methode iterator() besitzt.) Ist eine Collection gegeben, so bleibt nichts anderes übrig, als eine temporäre Datenstruktur aufzubauen, Element für Element den Iterator abzulaufen und diese Elemente in die temporäre Datenstruktur zu setzen, die dann Argument der Methode enumeration() wird.
Der zweite Fall ist einfacher. Ist eine Enumeration gegeben, liefert list() eine ArrayList – der Rückgabetyp ist wirklich sehr erstaunlich, da er ungewöhnlich konkret ist. Die ArrayList ist eine Collection und somit Iterable, kann also rechts vom Doppelpunkt beim erweiterten for stehen bzw. liefert mit iterator() einen Iterator.
Blick über den Tellerrand
Unter C++ ist die Standard Template Library (STL) eine Bibliothek, die Datenstrukturen und Algorithmen implementiert. Ein Vergleich der STL mit der Collection-API ist schwierig, obwohl beide Konzepte wie Listen, Mengen und Iteratoren besitzen. So gibt es in Java nur eine Klasse pro Datenstruktur (auch durch Generics), was die STL durch Template-Klassen (daher Template Library) realisiert, die auch primitive Werte (ohne die lästigen Java-Wrapper) speichert. Während Java über den globalen Basistyp Object jedes Objekt in jeder Datenstruktur erlaubt und sich auf die Prüfung zur Laufzeit verlässt, ist C++ da viel strenger. Die Java-Datenstrukturen referenzieren die Objekte und speichern nicht ihre Zustände an sich, wie es bei der STL üblich ist – hier steht Referenz-Semantik gegen Wert-Semantik. Fehler werden von der Collection-API über Exceptions angezeigt, während die STL kaum Ausnahmen auslöst und oft undefinierte Zustände hinterlässt; Entwickler müssen eben korrekte Anfragen stellen. STL nutzt überladene Operatoren wie == statt des Java-equals(…), < für die Ordnung in sortierten Sammlungen, [] beim Zugriff und Überschreiben und den Operator ++ für Iteratoren. Iteratoren spielen bei der STL eine sehr große Rolle – es gibt auch einen Random-Access-Iterator, der Indexierung durch [] erlaubt. Die STL-Algorithmen sind von den Datenstrukturen abgetrennt – anders als in Java – und bekommen die Elemente über Iteratoren.
