3.2 Listen

Eine Liste steht für eine Sequenz von Daten, bei der die Elemente eine feste Reihenfolge besitzen. Die Schnittstelle java.util.List schreibt Verhalten vor, die alle konkreten Listen implementieren müssen. Interessante Realisierungen der List-Schnittstelle sind:

• java.util.ArrayList: Liste auf der Basis eines Feldes
• java.util.LinkedList: Liste durch verkettete Elemente
• java.util.concurrent.CopyOnWriteArrayList: schnelle Liste, optimal für häufige nebenläufige Lesezugriffe
• java.util.Vector : synchronisierte Liste seit Java 1.0, die der ArrayList wich. Die Klasse ist zwar nicht deprecated, sollte aber nicht mehr verwendet werden.

Die Methoden zum Zugriff über die gemeinsame Schnittstelle List sind immer die gleichen. So ermöglicht jede Liste einen Punktzugriff über get(index), und jede Liste kann alle gespeicherten Elemente sequenziell über einen Iterator geben. Doch die Realisierungen einer Liste unterscheiden sich in Eigenschaften wie der Performance, dem Speicherplatzbedarf oder der Möglichkeit der sicheren Nebenläufigkeit.

Da in allen Datenstrukturen jedes Exemplar einer von Object abgeleiteten Klasse Platz findet, sind die Listen grundsätzlich nicht auf bestimmte Datentypen fixiert, doch Generics spezifizieren diese Typen genauer.

3.2.1 Erstes Listen-Beispiel

Listen haben die wichtige Eigenschaft, dass sie sich die Reihenfolge der eingefügten Elemente merken und dass Elemente auch doppelt vorkommen können. Wir wollen diese Listenfähigkeit für ein kleines Gedächtnisspiel nutzen. Der Anwender gibt Städte für eine Route vor, die sich das Programm in einer Liste merkt. Nach der Eingabe eines neuen Ziels auf der Route soll der Anwender alle Städte in der richtigen Reihenfolge wiedergeben. Hat er das geschafft, kommt eine neue Stadt hinzu. Im Prinzip ist das Spiel unendlich, doch da sich kein Mensch unendlich viele Städe in der Reihenfolge merken kann, wird es zu einer Falscheingabe kommen, was das Programm beendet.

Listing 3.3: com/tutego/insel/util/list/HowDoesYourRouteLooksLike.java

package com.tutego.insel.util.list;

import java.text.*;
import java.util.*;

public class HowDoesYourRouteLooksLike
{
  public static void main( String[] args )
  {
    List<String> cities = new ArrayList<String>();

    while ( true )
    {
      System.out.println( "Welche neue Stadt kommt hinzu?" );
      String newCity = new Scanner( System.in ).nextLine();
      cities.add( newCity );

      System.out.printf( "Wie sieht die gesamte Route aus? (Tipp: %d %s)%n",
                         cities.size(),
                         cities.size() == 1 ? "Stadt" : "Städte" );

      for ( String city : cities )
      {
        String guess = new Scanner( System.in ).nextLine();
        if ( ! city.equalsIgnoreCase( guess ) )
        {
          System.out.printf( "%s ist nicht richtig, %s wäre korrekt. Schade!%n",
                             guess, city );
          return;
        }
      }
      System.out.println( "Prima, alle Städte in der richtigen Reihenfolge!" );
    }
  }
}

3.2.2 Auswahlkriterium ArrayList oder LinkedList

Eine ArrayList (das Gleiche gilt für Vector) speichert Elemente in einem internen Array. LinkedList dagegen speichert die Elemente in einer verketteten Liste und realisiert die Verkettung mit einem eigenen Hilfsobjekt für jedes Listenelement. Es ergeben sich Einsatzgebiete, die einmal für LinkedList und einmal für ArrayList sprechen:

• Da ArrayList intern ein Array benutzt, ist der Zugriff auf ein spezielles Element über die Position in der Liste sehr schnell. Eine LinkedList muss aufwändiger durchsucht werden, und dies kostet Zeit.
• Die verkettete Liste ist aber deutlich im Vorteil, wenn Elemente mitten in der Liste gelöscht oder eingefügt werden; hier muss einfach nur die Verkettung der Hilfsobjekte an einer Stelle verändert werden. Bei einer ArrayList bedeutet dies viel Arbeit, es sei denn, das Element kann am Ende gelöscht oder – bei ausreichender Puffergröße – eingefügt werden. Soll ein Element nicht am Ende eingefügt oder gelöscht werden, müssen alle nachfolgenden Listenelemente verschoben werden.
• Bei einer ArrayList kann die Größe des internen Feldes zu klein werden. Dann bleibt der Laufzeitumgebung nichts anderes übrig, als ein neues, größeres Feld-Objekt anzulegen und alle Elemente zu kopieren.

3.2.3 Die Schnittstelle List

Die Schnittstelle List schreibt das allgemeine Verhalten für Listen vor. Viele Methoden kennen wir schon vom Collection-Interface, und zwar deshalb, weil List die Schnittstelle Collection erweitert. Hinzugekommen sind Methoden, die einen Bezug zur Position eines Elements haben – Mengen, die auch Collection implementieren, kennen keinen Index.

Hinzufügen und Setzen von Elementen

Die add()-Methode fügt neue Elemente an die Liste an, wobei eine Position die Einfügestellen bestimmen kann. Die Methode addAll() fügt fremde Elemente einer anderen Sammlung in die Liste ein. set() setzt ein Element an eine bestimmte Stelle, überschreibt das ursprüngliche Element und verschiebt es auch nicht wie add(). Die Methode size() nennt die Anzahl der Elemente in der Datenstruktur:

Listing 3.4: com/tutego/insel/util/list/ListDemo.java. main()

List<String> list1 = new ArrayList<String>();
list1.add( "Eva" );
list1.add( 0, "Charisma" );
list1.add( "Pallas" );

List<String> list2 = Arrays.asList( "Tina", "Wilhelmine" );
list1.addAll( 3, list2 );
list1.add( "XXX" );
list1.set( 5, "Eva" );

System.out.println( list1 );        // [Charisma, Eva, Pallas, Tina, Wilhelmine, Eva]
System.out.println( list1.size() ); // 6

Positionsanfragen und Suchen

Ob die Sammlung leer ist, bestimmt isEmtpy(). Ein Element an einer speziellen Stelle erfragen kann get(). Ob Elemente Teil der Sammlung sind, beantworten contains() und containsAll(). Wie bei Strings liefern indexOf() und lastIndexOf() die Fundpositionen:

boolean b = list1.contains( "Tina" );
System.out.println( b );            // true

b = list1.containsAll( Arrays.asList( "Tina", "Eva" ) );
System.out.println( b );            // true

Object o = list1.get( 1 );
System.out.println( o );            // Eva

int i = list1.indexOf( "Eva" );
System.out.println( i );            // 1

i = list1.lastIndexOf( "Eva" );
System.out.println( i );            // 5

System.out.println( list1.isEmpty() ); // false

Listen zu Feldern und neue Listen bilden

Von den Listen können Arrays abgeleitet werden und sich Schnittmengen bilden lassen:

String[] array = list1.toArray( new String[list1.size()] );
System.out.println( array[3] );     // "Tina"

List<String> list3 = new LinkedList<String>( list1 );
System.out.println( list3 );        // [Charisma, Eva, Pallas, Tina,
                                    // Wilhelmine, Eva]
list3.retainAll( Arrays.asList( "Tina", "Eva" ) );
System.out.println( list3 );        // [Eva, Tina, Eva]

Löschen von Elementen

Außerdem gibt es Methoden zum Löschen von Elementen. Hier bietet die Liste eine überladene remove()-Methode und removeAll(). Den kürzesten Weg, um alles aus der Liste zu löschen, bietet clear():

System.out.println( list1 );     // [Charisma, Eva, Pallas, Tina, Wilhelmine, Eva]
list1.remove( 1 );
System.out.println( list1 );     // [Charisma, Pallas, Tina, Wilhelmine, Eva]

list1.remove( "Wilhelmine" );
System.out.println( list1 );     // [Charisma, Pallas, Tina, Eva]

list1.removeAll( Arrays.asList( "Pallas", "Eva" ) );
System.out.println( list1 );     // [Charisma, Tina]

list1.clear();
System.out.println( list1 );     // []

Abbildung 3.3: UML-Diagramm von List mit Basistypen

Die Methoden der Schnittstelle List sind:

interface java.util.List<E>
extends Collection<E>

• boolean add(E o)
  Fügt das Element am Ende der Liste an. Eine optionale Operation.
• void add(int index, E element)
  Fügt ein Objekt an der angegebenen Stelle in die Liste ein. Eine optionale Operation.
• boolean addAll(int index, Collection<? extends E> c)
  Fügt alle Elemente der Collection an der angegebenen Stelle in die Liste ein. Eine optionale Operation.
• void clear()
  Löscht alle Elemente aus der Liste. Eine optionale Operation.
• boolean contains(Object o)
  Liefert true, wenn das Element o in der Liste ist. Den Vergleich übernimmt equals(), und es ist kein Referenz-Vergleich.
• boolean containsAll(Collection<?> c)
  Liefert true, wenn alle Elemente der Sammlung c in der aktuellen Liste sind.
• E get(int index)
  Wird das Element an dieser angegebenen Stelle der Liste liefern.
• int indexOf(Object o)
  Liefert die Position des ersten Vorkommens für o oder –1, wenn kein Listenelement mit o inhaltlich – also per equals() und nicht per Referenz – übereinstimmt. Leider gibt es keine Methode, um ab einer bestimmten Stelle weiterzusuchen, so wie sie die Klasse String bietet. Dafür lässt sich jedoch eine Teilliste einsetzen, die subList() bildet – eine Methode, die später in der Aufzählung folgt.
• boolean isEmpty()
  Liefert true, wenn die Liste leer ist.
• Iterator<E> iterator()
  Liefert den Iterator. Die Methode ruft aber listIterator() auf und gibt ein ListIterator-Objekt zurück.
• int lastIndexOf(Object o)
  Sucht von hinten in der Liste nach dem ersten Vorkommen von o und liefert –1, wenn kein Listenelement inhaltlich mit o übereinstimmt.
• ListIterator<E> listIterator()
  Liefert einen Listen-Iterator für die ganze Liste. Ein Listen-Iterator bietet gegenüber dem allgemeinen Iterator für Container zusätzliche Operationen.
• ListIterator<E> listIterator(int index)
  Liefert einen Listen-Iterator, der die Liste ab der Position index durchläuft.
• E remove(int index)
  Entfernt das Element an der Position index aus der Liste.
• boolean remove(Object o)
  Entfernt das erste Objekt in der Liste, das equals()-gleich mit o ist. Liefert true, wenn ein Element entfernt wurde. Eine optionale Operation.
• boolean removeAll(Collection<?> c)
  Löscht in der eigenen Liste die Elemente aus c. Eine optionale Operation.
• boolean retainAll(Collection<?> c)
  Optional. Entfernt alle Objekte aus der Liste, die nicht in der Collection c vorkommen.
• E set(int index, E element)
  Ersetzt das Element an der Stelle index durch element. Eine optionale Operation.
• List<E> subList(int fromIndex, int toIndex)
  Liefert den Ausschnitt dieser Liste von Position fromIndex (einschließlich) bis toIndex (nicht mit dabei). Die zurückgelieferte Liste stellt eine Ansicht eines Ausschnitts der Originalliste dar. Änderungen an der Teilliste wirken sich auf die ganze Liste aus und umgekehrt (soweit sie den passenden Ausschnitt betreffen).
• boolean equals(Object o)
  Vergleicht die Liste mit einer anderen Liste. Zwei Listen-Objekte sind gleich, wenn ihre Elemente paarweise gleich sind.
• int hashCode()
  Liefert den Hashcode der Liste.

Was List der Collection hinzufügt, sind also die Index-basierten Methoden add(int index, E element), addAll(int index, Collection<? extends E> c), get(int index), indexOf(Object o), lastIndexOf(Object o), listIterator(), listIterator(int index), remove(int index), set(int index, E element) und subList(int fromIndex, int toIndex).

Nach Elementen suchen und ihre Position ausgeben

Ein zweites Beispiel zeigt die Möglichkeit von index() und subList(), um alle Positionen eines Elements in einer Liste zu finden. Die Code-Kompression gewinnt sicherlich keinen Preis. Arrays.asList() erzeugt aus einer Aufzählung eine Liste:

Listing 3.5: com/tutego/insel/util/list/IndexOfSubList.java, main()

List<Integer> list = Arrays.asList( 1, 3, 4, 1 );
Integer o = 1;

for ( int i = list.indexOf( o ), j = –1;
      i > j;
      j = i, i += list.subList( i + 1, list.size() ).indexOf( o ) + 1 )
{
  System.out.println( i );
}

Da nach 1 gesucht wurde, ist die Ausgabe 0 und 3.

Kopieren und Ausschneiden

Die Listen-Klassen implementieren clone() und erzeugen eine flache Kopie.

Um einen Bereich zu löschen, nutzen wir subList(from, to).clear(). Die subList()-Technik deckt gleich noch einige andere Operationen ab, für die es keine speziellen Range-Varianten gibt, zum Beispiel indexOf(), also die Suche in einem Teil der Liste.

List<String> list = new ArrayList<String>(
    Arrays.asList( "0 1 2 3 4 5 6 7 8 9".split( " " ) ) );
list.subList( 2, list.size() – 2 ).clear();
System.out.println( list );                   // [0, 1, 8, 9]
for ( ListIterator<String> it = list.listIterator( list.size() );
      it.hasPrevious(); )
  System.out.print( it.previous() + " " );    // 9 8 1 0

subList() erzeugt wie viele andere Methoden der Collection-Datenstrukturen eine Ansicht auf die Liste, was bedeutet, dass Änderungen an dieser Teilliste zu Änderungen des Originals führen. Das gilt auch für clear(), was dazu genutzt werden kann, einen Teilbereich der Originalliste zu löschen.

List<gewünschterTyp> list = new ArrayList<gewünschterTyp>() {
  @Override public void removeRange( int fromIndex, int toIndex ) {
    super.removeRange( fromIndex, toIndex );
  }
};

3.2.4 ArrayList

Jedes Exemplar der Klasse ArrayList vertritt ein Array mit variabler Länge. Der Zugriff auf die Elemente erfolgt effizient über Indizes, was ArrayList über die Implementierung der Markierungsschnittstelle RandomAccess andeutet.

Eine ArrayList erzeugen

Um ein ArrayList-Objekt zu erzeugen, existieren drei Konstruktoren:

class java.util.ArrayList<E>
extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, Serializable

• ArrayList()
  Eine leere Liste mit einer Anfangskapazität von zehn Elementen wird angelegt. Werden mehr als zehn Elemente eingefügt, muss die Liste sich vergrößern.
• ArrayList(int initialCapacity)
  Eine Liste mit initialCapacity freien Elementen wird angelegt.
• ArrayList(Collection<? extends E> c)
  Kopiert alle Elemente der Collection c in das neue ArrayList-Objekt.

Abbildung 3.4: UML-Diagramm von ArrayList mit Vererbungshierarchie

Die interne Arbeitsweise von ArrayList und Vector *

Die Klassen ArrayList und Vector verwalten zwei Größen: zum einen die Anzahl der gespeicherten Elemente nach außen, zum anderen die interne Größe des Felds. Ist die Kapazität des Felds größer als die Anzahl der Elemente, so können noch Elemente aufgenommen werden, ohne dass die Liste etwas unternehmen muss. Die Anzahl der Elemente in der Liste, die Größe, liefert die Methode size(); die Kapazität des darunterliegenden Arrays liefert capacity().

Die Liste vergrößert sich automatisch, falls mehr Elemente aufgenommen werden, als ursprünglich am Platz vorgesehen waren. Diese Operation heißt Resizing. Dabei spielt die Größe initialCapacity für effizientes Arbeiten eine wichtige Rolle. Sie sollte passend gewählt sein. Betrachten wir daher zunächst die Funktionsweise der Liste, falls das interne Array zu klein ist.

Wenn das Array zehn Elemente fasst, nun aber ein elftes eingefügt werden soll, so muss das Laufzeitsystem einen neuen Speicherbereich reservieren und jedes Element des alten Felds in das neue kopieren. Das kostet Zeit. Schon aus diesem Grund sollte der Konstruktor ArrayList(int initialCapacity)/Vector(int initialCapacity) gewählt werden, weil dieser eine Initialgröße festsetzt. Das Wissen über unsere Daten hilft dann der Datenstruktur. Falls kein Wert voreingestellt wurde, so werden zehn Elemente angenommen. In vielen Fällen ist dieser Wert zu klein.

Nun haben wir zwar darüber gesprochen, dass ein neues Feld angelegt wird und die Elemente kopiert werden, wir haben aber nichts über die Größe des neuen Feldes gesagt. Hier gibt es Strategien wie die »Verdopplungsmethode« beim Vector. Wird er vergrößert, so ist das neue Feld doppelt so groß wie das alte. Dies ist eine Vorgehensweise, die für kleine und schnell wachsende Felder eine clevere Lösung darstellt, großen Feldern jedoch schnell zum Verhängnis werden kann. Für den Fall, dass wir die Vergrößerung selbst bestimmen wollen, nutzen wir den Konstruktor Vector(int initialCapacity, int capacityIncrement), der die Verdopplung ausschaltet und eine fixe Vergrößerung befiehlt. Die ArrayList verdoppelt nicht, sie nimmt die neue Größe mal 1,5. Bei ihr gibt es leider auch nicht den capacityIncrement im Konstruktor.

Die Größe eines Feldes *

Die interne Größe des Arrays kann mit ensureCapacity() geändert werden. Ein Aufruf von ensureCapacity(int minimumCapacity) bewirkt, dass die Liste insgesamt mindestens minimumCapacity Elemente aufnehmen kann, ohne dass ein Resizing nötig wird. Ist die aktuelle Kapazität der Liste kleiner als minimumCapacity, so wird mehr Speicher angefordert. Der Vektor verkleinert die aktuelle Kapazität nicht, falls sie schon höher als minimumCapacity ist. Um aber auch diese Größe zu ändern und somit ein nicht mehr wachsendes Vektor-Array so groß wie nötig zu machen, gibt es, ähnlich wie beim String mit Leerzeichen, die Methode trimToSize(). Sie reduziert die Kapazität des Vektors auf die Anzahl der Elemente, die gerade in der Liste sind. Mit size() lässt sich die Anzahl der Elemente in der Liste erfragen. Sie gibt die wirkliche Anzahl der Elemente zurück.

Bei der Klasse Vector lässt sich mit setSize(int newSize) auch die Größe der Liste verändern. Ist die neue Größe kleiner als die alte, werden die Elemente am Ende des Vektors abgeschnitten. Ist newSize größer als die alte Größe, werden die neu angelegten Elemente mit null initialisiert.[19](Zudem können null-Referenzen ganz normal als Elemente eines Vektors auftreten, bei den anderen Datenstrukturen gibt es Einschränkungen.) Vorsicht ist bei newSize=0 geboten, denn setSize(0) bewirkt das Gleiche wie removeAllElements().

3.2.5 LinkedList

Die Klasse LinkedList realisiert die Schnittstelle List als verkettete Liste und bildet die Elemente nicht auf ein Feld ab. Die Implementierung realisiert die LinkedList als doppelt verkettete Liste, in der jedes Element – die Ränder lassen wir außen vor – einen Vorgänger und Nachfolger hat. (Einfach verkettete Listen haben nur einen Nachfolger, was die Navigation in beide Richtungen schwierig macht.)

Abbildung 3.5: Klassendiagramm von LinkedList mit Vererbungsbeziehungen

Eine LinkedList hat neben den gegebenen Operationen aus der Schnittstelle List weitere Hilfsmethoden: Dabei handelt es sich um die Methoden addFirst(), addLast(), getFirst(), getLast(), removeFirst() und removeLast(). Die implementierten Schnittstellen Queue und Deque sind nicht ganz unschuldig an diesen neuen Methoden.

class java.util.LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneable, Serializable

• LinkedList()
  Erzeugt eine neue leere Liste.
• LinkedList(Collection<? extends E> c)
  Kopiert alle Elemente der Collection c in die neue verkettete Liste.

3.2.6 Der Feld-Adapter Arrays.asList()

Arrays von Objektreferenzen und dynamische Datenstrukturen passen nicht so richtig zusammen, obwohl sie schon häufiger zusammen benötigt werden. Die Java-Bibliothek bietet mit der statischen Methode Arrays.asList() an, ein existierendes Feld als java.util.List zu behandeln. Der Parametertyp ist ein Vararg – was ja intern auf ein Feld abgebildet wird –, sodass sich asList() auf zwei Arten verwenden lässt:

• Arrays.asList(array): Die Variable array ist eine Referenz auf ein Feld, und das Ergebnis ist eine Liste, die die gleichen Elemente wie das Feld enthält.
• Arrays.asList(e1, e2, e3): Die Elemente e1, e2, e3 sind Elemente der Liste.

Das Entwurfsmuster, das die Java-Bibliothek bei der statischen Methode anwendet, nennt sich Adapter. Es löst das Problem, die Schnittstellen eines Typs auf eine andere Schnittstelle eines anderen Typs anzupassen.

String s = "Oten :-) Bilat :-) Iyot";
int i = Collections.frequency( Arrays.asList(s.split("\\s")), ":-)" );
System.out.println( i );    // 2

class java.util.Arrays

• public static <T> List<T> asList(T... a)
  Ermöglicht es, mit der Schnittstelle einer Liste Zugriff auf ein Feld zu erhalten. Die variablen Argumente sind sehr praktisch.

Internes

Die Rückgabe von asList() ist kein konkreter Klassentyp wie ArrayList oder LinkedList, sondern irgendetwas Unbekanntes, was asList() als List herausgibt. Diese Liste ist nur eine andere Ansicht des Feldes.

Jetzt gibt es allerdings einen Interpretationsspielraum, was genau mit der Rückgabe möglich ist. Zudem ist es nicht ganz uninteressant zu wissen, ob die Liste einen schnellen Punktzugriff zulässt (RandomAccess implementiert) bzw. ob optionale Operationen wie Veränderungen oder sogar totale Reorganisationen denkbar sind. Ein Blick auf die Implementierung verrät mehr. Das Ergebnis ist ein Adapter, der Listen-Methoden wie get(index) oder set(index, element) direkt auf das Feld umleitet. Da Feldlängen final sind, führen Modifikationsmethoden wie remove() oder add() zu einer UnsupportedOperationException.

List<String> list = new ArrayList<String>( Arrays.asList( "A", "B" ) );
list.add( "C" );

3.2.7 ListIterator *

Die Schnittstelle ListIterator ist eine Erweiterung von Iterator. Diese Schnittstelle fügt noch Methoden hinzu, damit an der aktuellen Stelle auch Elemente eingefügt werden können. Mit einem ListIterator lässt sich rückwärts laufen und auf das vorhergehende Element zugreifen:

Listing 3.6: com/tutego/insel/util/list/ListIteratorDemo.java, main()

List<String> list = new ArrayList<String>();
Collections.addAll( list, "b", "c", "d" );

ListIterator<String> it = list.listIterator();

it.add( "a" );                     // Vorne anfügen
System.out.println( list );        // [a, b, c, d]

it.next();                         // Position vor
it.remove();                       // Element löschen
System.out.println( list );        // [a, c, d]

it.next();                         // Position vor
it.set( "C" );                     // Element ersetzen
System.out.println( list );        // [a, C, d]

it = list.listIterator( 1 );       // Neuen Iterator mit Startpos. 1
it.add( "B" );                     // B hinzufügen
System.out.println( list );        // [a, B, C, d]

it = list.listIterator( list.size() );

it.previous();                     // Eine Stelle nach vorne
it.remove();                       // Und letztes Element löschen
System.out.println( list );        // [a, B, C]

List<String> list = new ArrayList<String>();
Collections.addAll( list, "1", "2", "3", "4" );
for ( ListIterator<String> it = list.listIterator( list.size() );
      it.hasPrevious(); )
  System.out.print( it.previous() + " " ); // 4 3 2 1

interface ListIterator<E>
extends Iterator<E>

• boolean hasPrevious()
• boolean hasNext()
  Liefert true, wenn es ein vorhergehendes/nachfolgendes Element gibt.
• E previous()
• E next()
  Liefert das vorangehende/nächste Element der Liste oder NoSuchElementException, wenn es das Element nicht gibt.
• int previousIndex()
• int nextIndex()
  Liefert den Index des vorhergehenden/nachfolgenden Elements. Geht previousIndex() vor die Liste, so liefert die Methode die Rückgabe –1. Geht nextIndex() hinter die Liste, liefert die Methode die Länge der gesamten Liste.
• void remove()
  Optional. Entfernt das letzte von next() oder previous() zurückgegebene Element.
• void add(E o)
  Optional. Fügt ein neues Objekt in die Liste ein.
• void set(E o)
  Optional. Ersetzt das Element, das next() oder previous() als letztes zurückgegeben haben.

3.2.8 toArray() von Collection verstehen – die Gefahr einer Falle erkennen

Die toArray()-Methode aus der Schnittstelle Collection gibt laut Definition ein Array von Objekten zurück. Es ist wichtig, zu verstehen, welchen Typ die Einträge und das Array selbst haben. Eine Implementierung der Collection-Schnittstelle ist ArrayList.

ArrayList<Point> list = new ArrayList<Point>();
list.add( new Point(13, 43) );
list.add( new Point(9, 4) );
Object[] points = list.toArray();

Wir erhalten nun ein Feld mit Referenzen auf Point-Objekte, können jedoch zum Beispiel nicht einfach points[1].x schreiben, um auf das Attribut des Point-Exemplars zuzugreifen, denn das Array points hat den deklarierten Elementtyp Object. Es fehlt die explizite Typumwandlung, und erst ((Point)points[1]).x ist korrekt. Doch spontan kommen wir sicherlich auf die Idee, einfach den Typ des Arrays auf Point zu ändern. In dem Array befinden sich ja nur Referenzen auf Point-Exemplare:

Point[] points = list.toArray();             //  Compilerfehler

Jetzt wird der Compiler einen Fehler melden, weil der Rückgabewert von toArray() ein Object[] ist. Spontan reparieren wir dies, indem wir eine Typumwandlung auf ein Point-Array an die rechte Seite setzen:

Point[] points = (Point[]) list.toArray();   //  Problem zur Laufzeit

Jetzt haben wir zur Übersetzungszeit kein Problem mehr, aber zur Laufzeit wird es immer knallen, auch wenn sich im Array tatsächlich nur Point-Objekte befinden.

Diesen Programmierfehler müssen wir verstehen. Was wir falsch gemacht haben, ist einfach: Wir haben den Typ des Arrays mit den Typen der Array-Elemente durcheinandergebracht. Einem Array von Objekt-Referenzen können wir alles zuweisen:

Object[] os = new Object[ 3 ];
os[0] = new Point();
os[1] = "Trecker fahr’n";
os[2] = new Date();

Wir merken, dass der Typ des Arrays Object[] ist, und die Array-Elemente sind ebenfalls vom Typ Object. Hinter dem new-Operator, der das Array-Objekt erzeugt, steht der gemeinsame Obertyp für zulässige Array-Elemente. Bei Object[]-Arrays dürfen die Elemente Referenzen für beliebige Objekte sein. Klar ist, dass ein Array nur Objektreferenzen aufnehmen kann, die mit dem Typ für das Array selbst kompatibel sind, sich also auf Exemplare der angegebenen Klasse beziehen oder auf Exemplare von Unterklassen dieser Klasse:

/* 1 */  Object[] os = new Point[3];
/* 2 */  os[0] = new Point();
/* 3 */  os[1] = new Date();           // !!
/* 4 */  os[2] = "Trecker fahr’n";     // !!

Zeile 3 und 4 sind vom Compiler erlaubt, führen aber zur Laufzeit zu einer ArrayStoreException.

Kommen wir wieder zur Methode toArray() zurück. Weil die auszulesende Datenstruktur alles Mögliche enthalten kann, muss der Typ der Elemente also Object sein. Wir haben gerade festgestellt, dass der Elementtyp des Array-Objekts, das die Methode toArray() als Ergebnis liefert, mindestens so umfassend sein muss. Da es keinen allgemeineren (umfassenderen) Typ als Object gibt, ist auch der Typ des Arrays Object[]. Dies muss so sein, auch wenn die Elemente einer Datenstruktur im Einzelfall einen spezielleren Typ haben. Einer allgemein gültigen Implementierung von toArray() bleibt gar nichts anderes übrig, als das Array vom Typ Object[] und die Elemente vom Typ Object zu erzeugen.

Wenn sich auch die Elemente wieder in einen spezielleren Typ konvertieren lassen, ist das bei dem Array-Objekt selbst jedoch nicht der Fall. Ein Array-Objekt mit Elementen vom Typ X ist nicht automatisch auch selbst vom Typ X[], sondern von einem Typ Y[], wobei Y eine (echte) Oberklasse von X ist.

Die Lösung für das Problem

Bevor wir nun eine Schleife mit einer Typumwandlung für jedes einzelne Array-Element schreiben oder eine Typumwandlung bei jedem Zugriff auf die Elemente vornehmen, sollten wir einen Blick auf die zweite toArray()-Methode werfen. Sie akzeptiert als Parameter ein vorgefertigtes Array für das Ergebnis. Mit dieser Methode lässt sich erreichen, dass das Ergebnis-Array von einem spezielleren Typ als Object[] ist.

List<Point> list = new ArrayList<Point>();
list.add( new Point(13,43) );
list.add( new Point(9,4) );
Point[] points = (Point[]) list.toArray( new Point[0] );

ArrayList<Point> list = new ArrayList<Point>();
list.add( new Point(13,43) );
list.add( new Point(9,4) );
Point[] points = (Point[]) list.toArray( new Point[list.length()] );

Felder mit Reflection anlegen *

Spannend ist die Frage, wie so etwas funktionieren kann. Dazu verwendet die Methode toArray(Object[]) die Technik Reflection, um dynamisch ein Array vom gleichen Typ wie das übergebene Array zu erzeugen. Intensiver wird dieses Thema in Kapitel 18, »Reflection und Annotationen«, behandelt; anr dieser Stelle erfolgt jedoch schon ein kleiner Vorgriff.

Wollten wir ein Array b vom Typ des Arrays a mit Platz für len Elemente anlegen, so schreiben wir:

Object[] b=(Object[])Array.newInstance( a.getClass().getComponentType(), len );

Mit a.getClass().getComponentType() erhalten wir ein Class-Objekt für den Elementtyp des Arrays. Zum Beispiel liefert das Class-Objekt Point.class für die Klasse Point. a.getClass() allein ein Class-Objekt für das Array a, etwa ein Objekt, das den Typ Point[] repräsentiert. Array.newInstance(), eine statische Methode von java.lang.reflect.Array, konstruiert ein neues Array mit dem Elementtyp aus dem Class-Objekt und der angegebenen Länge. Nichts anderes macht auch ein new X[len], nur dass hier der Elementtyp zur Übersetzungszeit festgelegt werden muss. Da der Rückgabewert von newInstance() ein allgemeines Object ist, muss letztendlich noch die Konvertierung in ein passendes Array stattfinden.

Ist das übergebene Array so groß, dass es alle Elemente der Sammlung aufnehmen kann, kopiert toArray() die Elemente aus der Collection in das Feld. Oft wird dort aber ein new X[0] anzeigen, dass wir ein neu erzeugtes Array-Objekt wünschen. Im Übrigen entspricht natürlich toArray(new Object[0]) dem Aufruf von toArray(). Dennoch gibt die Java-Bibliothek zwei völlig getrennte Implementierungen an, da toArray() einfacher und effizienter zu implementieren ist.

3.2.9 Primitive Elemente in Datenstrukturen verwalten

Jede Datenstruktur der Collection-API akzeptiert, auch wenn sie generisch verwendet wird, nur Objekte. Primitive Datentypen nehmen die Sammlungen nicht auf, was zur Konsequenz hat, dass Wrapper-Objekte nötig sind (über das Boxing fügt Java 5 scheinbar primitive Elemente ein, doch in Wahrheit sind es Wrapper-Objekte). Auch wenn es also

List<Double> list = new ArrayList<Double>();
list.add( 1.1 );
list.add( 2.2 );

heißt, sind es zwei neue Double-Objekte, die aufgebaut werden und in die Liste wandern. Anders und klarer geschrieben, sehen wir hier, was wirklich passiert:

List<Double> list = new ArrayList<Double>();
list.add( Double.valueOf(1.1) );
list.add( new Double(2.2) );

Dem Aufruf von Double.valueOf() ist der new-Operator nicht abzulesen, doch die Methode ist implementiert als: Double valueOf(double d){ return new Double(d); }.

Spezialbibliotheken

Für performante Anwendungen und große Mengen von primitiven Elementen ist es sinnvoll, eine Klasse für den speziellen Datentyp einzusetzen. Anstatt so etwas selbst zu programmieren, kann der Entwickler auf drei Implementierungen zurückgreifen:

• fastutil (http://fastutil.dsi.unimi.it/): Erweiterung um Datenstrukturen für (sehr viele) primitive Elemente und hochperformante Ein-/Ausgabe-Klassen.
• GNU Trove (http://trove.starlight-systems.com/): Stabil, und die Entwicklung ist aktiv. Neue Datenstrukturen aus Java 5 oder 6 wie Queues zählen jedoch nicht dazu.
• Apache Commons Primitives (http://jakarta.apache.org/commons/primitives/): Stabil in der Version 1.0, aber seit Ende 2003 nicht mehr aktualisiert.

Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen.