Iterasjon med Iterator og Iterable

Iterator-basert løkke

Mange objekter inneholder samlinger av elementer. Eksempelvis vil et Familie-objekt inneholde en samling av personer, mens et Bibliotek-objekt vil ha en samling av bøker. En iterator er et objekt som lar deg iterere, altså gå gjennom alle elementene til et annet objekt. (Når vi sier noe er en iterator, så mener vi egentlig at det er en instans av Iterator-grensesnittet.) Iteratoren husker hvor langt en er kommet i rekken av elementer og underveis kan den 1) si om det er flere elementer igjen med hasNext()-metoden og 2) levere neste element og gå ett steg videre med next()-metoden. Logikken i en iterator-basert løkke blir som følger:

// antar her at samlingen med elementer er String-objekter
Iterator<String> iterator = ...
// så lenge det er flere elementer igjen
while (iterator.hasNext()) {
	// hent ut neste element og (implisitt) ta et steg videre
	String element = iterator.next();
	// gjør noe med elementet som element-variablen refererer til her
	...
}

Her er det viktig å merke seg to ting:

1. Det er ikke lov til (det gjøres på egen risiko) å kalle next() uten først å ha sjekket om det er flere elementer med hasNext().
2. Når en har gått gjennom alle elementene, er iteratoren brukt opp og kan ikke restartes.

Fordelen med en Iterator er at løkke-koden blir den samme uavhengig av hva slags data-kilde (altså objektet som holder på elementene) en har og hvordan den er implementert. Så lenge en har en Iterator-implementasjon som passer, så tar den seg av detaljene om hvordan 1) huske hvor langt en er kommet og 2) hente ut neste element.

java.util.Iterator-grensesnittet

Iterator-grensesnittet er som Collection-klassene, spesialisert til typen til elementene. En bruker altså ikke Iterator alene i deklarasjoner, men Iterator<element-type>, hvor <element-type> er den spesifikk typen objekter en itererer over, f.eks. String, Person eller Card.

Iterator-grensesnittet inneholder følgende tre metoder:

• boolean hasNext() - returnerer true hvis det er flere elementer igjen av sekvensen av elementer og false ellers. Denne metoden kan kalles mange ganger uten at det endrer hvor langt en er kommet.
• <type> next() - returnerer neste element i sekvensen og tar implisitt et steg videre. Returtypen er typen som Iterator-implementasjonen er spesialisert til. Denne metoden kan bare kalles dersom hasNext() returnerer true.
• void remove() - fjerner det siste elementet som ble returnert av next() fra den underliggende data-kilden, dersom den støtter dette. Denne metoden er frivillig å implementere, og dersom den ikke er støttet så skal den utløse UnsupportedOperationException.

Datakilder og Iterator-implementasjoner

I kode-eksemplet over er uttrykket som fremskaffer iteratoren utelatt, så hvor kommer så iteratorene fra? Siden det vanligvis er en tett kobling mellom implementasjonen av data-kilden og den tilhørende iteratoren, er det vanlig at det nettopp er datakilden som kan levere en iterator. F.eks. har begge de to standard List-implementasjonene ArrayList og LinkedList en iterator()-metode som returnerer en Iterator-implementasjon for sine data. Iteratoren for en ArrayList vil være ulik iteratoren for en LinkedList, men oppførselen vil være den samme: Den lar deg gå gjennom elementene med next(), så lenge hasNext() returnerer true. Faktisk er det å kunne levere en iterator så viktig for samlinger av objekter, at alle Collection-implementasjoner har en slik metode, og (siden List utvider Collection) dermed også alle List-implementasjoner. Dette betyr at alle Collection-objekter, støtter iterator-basert iterasjon, slik at vi hver gang vi trenger å løpe gjennom elementene i en Collection, kan bruke en iterator.

java.lang.Iterable-grensesnittet

Den vanlige måten å gå gjennom en liste med elementer er med kode som den under til venstre. Dette kalles en for-each-løkke, fordi den går gjennom hvert element i lista. Dette er egentlig spesial-syntaks for iterator-basert iterasjon, det er bare det at du aldri ser iteratoren. Funksjonelt sett er for-each-løkka til venstre ekvivalent med den Iterator-baserte løkka under til høyre. Det er egentlig en smaksak hvilken en bruker, men den venstre varianten er å foretrekke fordi den både er enklere å skrive og lese.

// gå gjennom stringListe
for (String s : stringListe) {
	// gjør noe med s her
	...
}

// få en iterator fra stringListe 
Iterator<String> stringIterator = stringListe.iterator();
// bruk hasNext og next for å gå gjennom lista
while (stringIterator.hasNext()) {
	String s : stringIterator.next(); 
	// gjør noe med s her
	...
}

Hvis en tenker over det, så er det nettopp iterator()-metoden, som er nøkkelen til at for-each-løkka virker. Det holder at stringListe i kode-eksemplet har en slik metode, for at den skal kunne "omskrives" til koden til høyre som den tilsvarer. Denne koblingen mellom for-each-løkka og iterator()-metoden er ikke tilfeldig, og for å gjøre koblingen eksplisitt og mulig å utnytte for klasser utenfor Collection-rammeverket, så er iterator()-metoden definert i et eget grensesnitt ved navn Iterable (i java.lang-pakken, så en slipper egen import-setning). Det er altså fordi en ArrayList implementerer Iterable at en for-each-løkke med en ArrayList virker! Og ArrayList implementerer Iterable fordi den implementerer List, og List utvider Collection som utvider Iterable. Denne koblingen mellom ArrayList og Iterable er illustrert under med et klassediagram:

Som vi ser er også Iterable spesialisert til element-typen. Så dersom en har en List<String> så har en implisitt en Iterable<String>, som har en iterator()-metode som returnerer en Iterator<String>, som har en next()-metode som returnerer en String.

Siden Iterable er et vanlig grensesnitt, så kan våre egne klasser utvide den og utnytte den kompakte for-each-syntaksen. Anta f.eks. at en har en Library-klasse, som bruker en ArrayList til å holde Book-objekter. Kode for en slik klasse er vist under til venstre. Dersom denne klassen også implementerer Iterable<Book> så kan en bruke for-each-løkka for å gå gjennom Book-objektene i et Library-objekt. Koden og klassediagram for denne utvidete Library-klassen er vist i midten og for-each-løkka er vist til høyre.

public class Library {

	private Collection<Book> books = new ArrayList<Book>();

	public void addBook(Book book) {
		books.add(book);
	}
	public void removeBook(Book book) {
		books.remove(book);
	}
}

public class Library implements Iterable<Book> {

	... books-feltet og add- og remove-metodene her ...

	// fra Iterable<Book>
	public Iterator<Book> iterator() {
		return books.iterator();
	}
}

// lag en Library-instans
Library library = new Library();
// legg til noen bøker
library.addBook(new Book(...));
library.addBook(new Book(...));

// gå gjennom bøkene
for (Book book : library) {
	// gjør noe med book her
	...
}