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 iterator()-metoden er definert i Collection-grensesnittet, som List bygger på. 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.

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.

// 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
	...
}

En Iterator for en Library-klasse kan se slik ut:

// OBS: Merk at metodene i denne klassen er uferdige. Logikken i hver metode vil avhenge av hvordan Library-klassen er.
 
import java.util.Iterator;

public class LibraryIterator implements Iterator<Book> {
	private Library library;
	// Eventuelle andre tilstander for å holde styr på iterasjonen
	
	public LibraryIterator(Library library) {
		this.library = library;
		// Sett eventuelle andre tilstander
	}
 
	public boolean hasNext() {
		boolean hasNext = false;
		// Kode for å sjekke om Library har flere Book-objekter
		return hasNext;
	}
 
	public Book next() {
		// Returner neste Book i Library
		return book;
	}
 
	public void remove() {
		// Kode for å fjerne sist returnerte bok eller la stå tom
	}
}

Iterable-grensesnittet

Når et objekt implementerer Iterable-grensesnittet sikrer man at det er mulig å iterere over objektet. Et Iterable<type>-objekt trenger kun å implementere én metode:

• Iterator<type> iterator() - returnerer en Iterator<type> for å iterere over objektet.

Under følger et eksempel på Library-klassen fra eksempelet over, som implementerer Iterable<Book>:

import java.util.Iterator;
 
public class Library implements Iterable<Book> {
	// Tilstander og andre metoder i klassen er ikke definert her
	
	public Iterator<Book> iterator() {
		return new LibraryIterator(this);
	}
}

I mange tilfeller bruker vi ArrayList eller andre typer lister som allerede implementerer Iterator-grensesnittet. Dette kan vi utnytte i nye klasser:

import java.util.Iterator;
 
public class Library implements Iterable<Book> {
	private ArrayList<Book> books;
	// Andre tilstander og metoder i klassen er ikke definert her
	
	public Iterator<Book> iterator() {
		// Returnerer ArrayList's iterator
		return books.iterator();
	}
}

Fordeler med Iterator / Iterable

Når et objekt implementerer Iterable<type> kan man bruke for-løkker av denne typen:

for (TypeObject element : IterableObject) {
	// Her går vi gjennom alle elementer i IterableObject-objektet, som inneholder TypeObject-objekter
}

I en liste eller andre objekter hvor elementerer har en definert rekkefølge er naturlig å iterere over objekter fra første element til siste element. I noen typer objekter er det derimot ikke like åpenbart hvilket element som skal hentes i neste iterasjon. I en matrise kan eksempelvis itereres over rad for rad eller kolonne for kolonne. Ved å lage en egen Iterator kan man spesifisere dette selv. Man kan også lage flere iteratorer for ett enkelt objekt.