7.2Basisklassen für die Ein-/Ausgabe 

Die Stromklassen aus dem java.io-Paket sind um drei zentrale Prinzipien aufgebaut:

1. Es gibt abstrakte Basisklassen, die Operationen für die Ein-/Ausgabe vorschreiben.

2. Die abstrakten Basisklassen gibt es einmal für Unicode-Zeichen und einmal für Bytes.

3. Die Implementierungen der abstrakten Basisklassen realisieren entweder die konkrete Ein-/Ausgabe in eine bestimmte Ressource (etwa eine Datei oder auch ein Bytefeld) oder sind Filter.

 

7.2.1Die abstrakten Basisklassen 

Die konkreten Ein-/Ausgabeklassen wie FileInputStream, FileOutputStream, FileWriter oder BufferedWriter erweitern abstrakte Oberklassen. Im Allgemeinen können wir vier Kategorien bilden: Klassen zur Ein-/Ausgabe von Bytes (oder Byte-Arrays) und Klassen zur Ein-/Ausgabe von Unicode-Zeichen (Arrays oder Strings).

Tabelle 7.2Basisklassen für Ein- und Ausgabe

Die Klassen InputStream und OutputStream bilden die Basisklassen für alle byteorientierten Klassen und dienen somit als Bindeglied bei Methoden, die als Parameter ein Eingabe- und Ausgabe-Objekt verlangen. So ist ein InputStream nicht nur für Dateien denkbar, sondern auch für Daten, die über das Netzwerk kommen. Das Gleiche gilt für Reader und Writer; sie sind die abstrakten Basisklassen zum Lesen und Schreiben von Unicode-Zeichen und Unicode-Zeichenfolgen. Die Basisklassen geben abstrakte read(…)- oder write(…)-Methoden vor, die Unterklassen überschreiben, da nur sie wissen, wie etwas tatsächlich gelesen oder geschrieben wird.

 

7.2.2Übersicht über Ein-/Ausgabeklassen 

Während die abstrakten Basisklassen von keiner konkreten Datenquelle lesen oder in keine Ressource schreiben, implementieren die Unterklassen eine ganz bestimmte Strategie für eine Ressource. So weiß zum Beispiel ein FileWriter, wie für Dateien die abstrakte Klasse Writer zu implementieren ist, also wie Unicode-Zeichen in eine Datei geschrieben werden.

Die folgenden Tabellen vermitteln einen Überblick über die wichtigsten Unterklassen von InputStream/OutputStream und Reader/Writer.

Die erste Tabelle listet die Eingabeklassen auf und stellt die byteorientierten und zeichenorientierten Klassen gegenüber, die zweite Tabelle zeigt die wesentlichen Ausgabeklassen:

Tabelle 7.3Wichtige Eingabeklassen. Die mit † markierten Klassen sind veraltet (deprecated).

Tabelle 7.4Wichtige Ausgabeklassen

Die beiden vorangehenden Tabellen sind nach Eingabe- und Ausgabeklassen segmentiert. Die Klassen lassen sich aber auch anders sortieren, etwa nach der Ressource:

Tabelle 7.5Ein-/Ausgabeklassen nach Ressourcenzugehörigkeit

 

7.2.3Die abstrakte Basisklasse OutputStream 

Der Clou bei allen Datenströmen ist, dass spezielle Unterklassen wissen, wie sie genau die vorgeschriebene Funktionalität implementieren. Wenn wir uns den OutputStream anschauen, dann sehen wir auf den ersten Blick, dass hier alle wesentlichen Operationen rund um das Schreiben versammelt sind. Das heißt, dass ein konkreter Stream, der in Dateien schreibt, nun weiß, wie er Bytes in Dateien schreiben wird. Java ist auf der unteren Ebene mit seiner Plattformunabhängigkeit am Ende, und native Methoden schreiben die Bytes.

• abstract void write(int b) throws IOException
  Schreibt ein einzelnes Byte in den Datenstrom.

• void write(byte[] b) throws IOException
  Schreibt die Bytes aus dem Array in den Strom.

• void write(byte[] b, int off, int len) throws IOException
  Schreibt Teile des Byte-Feldes, nämlich len Byte ab der Position off, in den Ausgabestrom.

• void close() throws IOException
  Schließt den Datenstrom. Einzige Methode aus Closeable.

• void flush() throws IOException
  Schreibt noch im Puffer gehaltene Daten. Einzige Methode aus der Schnittstelle Flushable.

Die IOException ist keine RuntimeException, muss also behandelt werden.

Zwei Eigenschaften lassen sich an den Methoden ablesen: zum einen, dass nur Bytes geschrieben werden, und zum anderen, dass nicht wirklich alle Methoden abstract sind. Nicht alle diese Methoden sind wirklich elementar, müssen also nicht von allen Ausgabeströmen überschrieben werden. Wir entdecken, dass nur write(int) abstrakt ist. Das würde aber bedeuten, dass alle anderen Methoden konkret wären. Gleichzeitig stellt sich die Frage, wie ein OutputStream, der die Eigenschaften für alle erdenklichen Ausgabeströme vorschreibt, denn wissen kann, wie ein spezieller Ausgabestrom etwa geschlossen (close()) wird oder seine gepufferten Bytes schreibt (flush()). Das weiß er natürlich nicht, aber die Entwickler haben sich dazu entschlossen, eine leere Implementierung anzugeben. Der Vorteil besteht darin, dass Programmierer von Unterklassen nicht verpflichtet werden, immer die Methoden zu überschreiben, auch wenn sie sie gar nicht nutzen wollen.

Über konkrete und abstrakte Schreibmethoden *

Es fällt auf, dass es zwar drei Schreibmethoden gibt, dass aber nur eine davon wirklich abstrakt ist. Das ist trickreich, denn tatsächlich lassen sich die Methoden, die ein Byte-Feld schreiben, auf die Methode abbilden, die ein einzelnes Byte schreibt. Wir werfen einen Blick in den Quellcode der Bibliothek:

Listing 7.7java/lang/OutputStream,java, Ausschnitt

An beiden Implementierungen ist zu erkennen, dass sie die Arbeit sehr bequem an andere Methoden verschieben. Doch diese Implementierung ist nicht optimal! Stellen wir uns vor, ein Dateiausgabestrom überschreibt nur die eine abstrakte Methode, die nötig ist. Und nehmen wir weiterhin an, dass unser Programm nun immer ganze Byte-Felder schreibt, etwa eine 5-MB-Datei, die im Speicher steht. Dann werden für jedes Byte im Byte-Array in einer Schleife alle Bytes der Reihe nach an eine vermutlich native Methode übergeben. Wenn es so implementiert wäre, könnten wir die Geschwindigkeit des Mediums überhaupt nicht nutzen, zumal jedes Dateisystem Funktionen bereitstellt, mit denen sich ganze Blöcke übertragen lassen. Glücklicherweise sieht die Implementierung nicht so aus, da wir in dem Modell vergessen haben, dass die Unterklasse zwar die abstrakte Methode implementieren muss, aber immer noch andere Methoden überschreiben kann. Ein späterer Blick auf die Klasse FileOutputStream bestätigt dies.

 

7.2.4Ein Datenschlucker * 

Damit wir sehen können, wie alle Unterklassen prinzipiell mit OutputStream umgehen, wollen wir eine Klasse entwerfen, die alle ihre gesendeten Daten verwirft. Die Klasse ist mit dem Unix-Device /dev/null vergleichbar. Die Implementierung ist die einfachste, die sich denken lässt, denn alle write(…)-Methoden machen nichts:

Listing 7.8com/tutego/insel/io/stream/NullOutputStream.java

Da close() und flush() ohnehin schon mit einem leeren Block implementiert sind, brauchen wir sie nicht noch einmal zu überschreiben. Aus Effizienzgründen (!) geben wir auch eine Implementierung für die Schreibfeld-Methoden an.

 

7.2.5Die abstrakte Basisklasse InputStream 

Das Gegenstück zu OutputStream ist InputStream; jeder binäre Eingabestrom wird durch die abstrakte Klasse InputStream repräsentiert. Die Konsoleneingabe System.in ist vom Typ InputStream.

• int available() throws IOException
  Gibt die Anzahl der verfügbaren Zeichen im Datenstrom zurück, die sofort ohne Blockierung gelesen werden können.

• abstract int read() throws IOException
  Liest ein Byte als Integer aus dem Datenstrom. Ist das Ende des Datenstroms erreicht, wird –1 übergeben. Die Methode ist überladen, wie die nächsten Signaturen zeigen.

• int read(byte[] b) throws IOException
  Liest mehrere Bytes in ein Feld. Die tatsächliche Länge der gelesenen Bytes wird zurückgegeben und muss nicht b.length sein, es können auch weniger Bytes gelesen werden.

• int read(byte[] b, int off, int len) throws IOException
  Liest den Datenstrom in ein Byte-Feld, schreibt ihn aber erst an der Stelle off in das Byte-Feld. Zudem begrenzt len die maximale Anzahl der zu lesenden Zeichen.

• long skip(long n) throws IOException
  Überspringt eine Anzahl von Zeichen. Die Rückgabe gibt die tatsächlich gesprungenen Bytes zurück, was nicht mit n identisch sein muss.

• void close() throws IOException
  Schließt den Datenstrom. Operation aus der Schnittstelle Closeable.

• boolean markSupported()
  Gibt einen Wahrheitswert zurück, der besagt, ob der Datenstrom das Merken und Zurücksetzen von Positionen gestattet. Diese Markierung ist ein Zeiger, der auf bestimmte Stellen in der Eingabedatei zeigen kann.

• void mark(int readlimit)
  Merkt sich eine Position im Datenstrom.

• void reset() throws IOException
  Springt wieder zu der Position zurück, die mit mark() gesetzt wurde.

Auffällig ist, dass bis auf mark(int) und markSupported() alle Methoden im Fehlerfall eine IOException auslösen.

 

7.2.6Ströme mit SequenceInputStream zusammensetzen * 

Ein SequenceInputStream-Filter hängt mehrere Eingabeströme zu einem großen Eingabestrom zusammen. Nützlich ist dies, wenn wir aus Strömen lesen wollen und es uns egal ist, was für ein Strom es ist, wo er startet und wo er aufhört. Der SequenceInputStream lässt sich erzeugen, indem im Konstruktor zwei InputStream-Objekte mitgegeben werden. Soll aus zwei Eingabeströmen ein zusammengesetzter Datenstrom gebildet werden, benutzen wir folgende Programmzeilen:

Ein Aufruf einer read(…)-Methode liest nun erst Daten aus s1. Liefert s1 keine Daten mehr, kommen die Daten aus s2. Liegen keine Daten mehr an s2, aber wieder an s1, ist es zu spät.

Für drei Ströme kann eine Kette aus zwei SequenceInputStream-Objekten gebaut werden:

Sollen mehr als zwei Ströme miteinander verbunden werden, kann auch eine Enumeration im Konstruktor übergeben werden. Die Enumeration einer Datenstruktur gibt dann die zu kombinierenden Datenströme zurück. Wir können entweder eine Datenstruktur wie Vector nutzen, die mit elements() einen Enumerator liefert, oder einer beliebigen Collection über Collections.enumeration(Collection<T> c) eine Enumeration entlocken.

• SequenceInputStream(InputStream s1, InputStream s2)
  Erzeugt einen SequenceInputStream aus zwei einzelnen InputStream-Objekten. Zuerst werden die Daten aus s1 gelesen und dann aus s2.

• SequenceInputStream(Enumeration<? extends InputStream> e)
  Die Eingabeströme für den SequenceInputStream werden aus der Enumeration mit nextElement() geholt. Ist ein Strom ausgesaugt, wird die close()-Methode aufgerufen und der nächste vorhandene Strom geöffnet.

• int available() throws IOException
  Liefert die Anzahl der Zeichen, die gelesen werden können. Die Daten betreffen immer den aktuellen Strom.

• int read() throws IOException
  Liefert das Zeichen oder –1, wenn das Ende aller Datenströme erreicht ist.

• int read(byte[] b, int off, int len) throws IOException
  Liest Zeichen in ein Feld und gibt die Anzahl tatsächlich gelesener Zeichen oder –1 zurück.

• void close() throws IOException
  Schließt alle Ströme, die vom SequenceInputStream-Objekt eingebunden sind.

Der folgende Programmausschnitt legt mit einem SequenceInputStream den Datenstrom eines ByteArrayInputStreams mit einem Datei-Datenstrom zusammen. Es werden anschließend Zeilennummern und Zeileninhalt ausgegeben, wobei sehr schön deutlich wird, dass erst der String und dann die Datei ausgelesen wird. Die Datei muss sich im Pfad befinden, da sie sonst nicht gefunden werden kann.

Listing 7.9com/tutego/insel/io/stream/SequenceInputStreamDemo.java, main()

Zum Ausgeben der Zeilen nutzt das Programm einen LineNumberReader, der neben der Methode readLine() auch die Methode getLineNumber() anbietet. Um für Unicode-Zeichen einen LineNumberReader aber überhaupt verwenden zu können – und keinen veralteten LineNumberInputStream für Bytes –, konvertiert ein InputStreamReader die byte des SequenceInputStream in char für den Reader. Es gibt leider keinen SequenceReader.

 

7.2.7Die abstrakte Basisklasse Writer 

Die Basis für alle wichtigen Klassen ist die abstrakte Basisklasse Writer.

• protected Writer(Object lock)
  Erzeugt einen Writer-Stream, der sich mit dem übergebenen Synchronisationsobjekt initialisiert. Ist die Referenz null, so gibt es eine NullPointerException.

• protected Writer()
  Erzeugt einen Writer-Stream, der sich selbst als Synchronisationsobjekt nutzt. Der Konstruktor ist für die Unterklassen interessant, die kein eigenes Lock-Objekt zuordnen wollen.

• void write(int c) throws IOException
  Schreibt ein einzelnes Zeichen. Von der 32-Bit-Ganzzahl wird der niedrige Teil (16 Bit des int) geschrieben.

• void write(char[] cbuf) throws IOException
  Schreibt ein Feld von Zeichen.

• abstract void write(char[] cbuf, int off, int len) throws IOException
  Schreibt len Zeichen des Feldes cbuf ab der Position off.

• void write(String str) throws IOException
  Schreibt einen String.

• void write(String str, int off, int len) throws IOException
  Schreibt len Zeichen der Zeichenkette str ab der Position off.

• Writer append(char c) throws IOException
  Hängt ein Zeichen an. Verhält sich wie write(c), nur liefert es, wie die Schnittstelle Appendable verlangt, ein Appendable zurück. Writer ist ein passendes Appendable.

• Writer append(CharSequence csq) throws IOException
  Hängt eine Zeichenfolge an. Implementierung aus der Schnittstelle Appendable.

• abstract void flush() throws IOException
  Schreibt den internen Puffer. Hängt verschiedene flush()-Aufrufe zu einer Kette zusammen, die sich aus der Abhängigkeit der Objekte ergibt. So werden alle Puffer geschrieben. Implementierung aus der Schnittstelle Flushable.

• abstract void close() throws IOException
  Schreibt den gepufferten Strom und schließt ihn. Nach dem Schließen durchgeführte write(…)- oder flush()-Aufrufe bringen eine IOException mit sich. Ein zusätzliches close() löst keine Exception aus. Implementierung aus der Schnittstelle Closeable.

Wie die abstrakten Methoden genutzt und überschrieben werden *

Uns fällt auf, dass von den sieben Methoden lediglich flush(), close() und write(char[], int, int) abstrakt sind. Zum einen bedeutet dies, dass konkrete Unterklassen nur diese Methoden implementieren müssen, und zum anderen, dass die übrigen write(…)-Methoden auf die eine überschriebene Implementierung zurückgreifen. Werfen wir daher einen Blick auf die Nutznießer:

Wird ein Zeichen geschrieben, so wird zunächst einmal nachgesehen, ob schon früher ein temporärer Puffer eingerichtet wurde (ein schöner Trick, denn Speicherbeschaffung ist nicht ganz billig). Wenn nicht, dann erzeugt die Methode zunächst ein Array mit der Größe von 1.024 Zeichen (dies ist die eingestellte Puffergröße). Dann schreibt write(int) das Zeichen in den Puffer und ruft die abstrakte Methode auf – die ja in einer Unterklasse implementiert wird. Ist der Parameter ein Feld, so muss lediglich die Größe an die abstrakte Methode übergeben werden. Alle Schreiboperationen sind mit einem lock-Objekt synchronisiert und können sich demnach nicht in die Quere kommen. Die Synchronisation wird entweder durch ein eigenes lock-Objekt durchgeführt, das dann im Konstruktor angegeben werden muss, oder die Klasse verwendet das this-Objekt der Writer-Klasse als Sperrobjekt.

 

7.2.8Die Schnittstelle Appendable * 

Alle Writer und auch die Klassen PrintStream, CharBuffer sowie StringBuffer und StringBuilder implementierten die Schnittstelle Appendable, die drei Methoden vorschreibt:

• Appendable append(char c)
  Hängt das Zeichen c an das aktuelle Appendable an und liefert das aktuelle Objekt vom Typ Appendable wieder zurück.

• Appendable append(CharSequence csq)
  Hängt die Zeichenfolge an dieses Appendable an und liefert es wieder zurück.

• Appendable append(CharSequence csq, int start, int end)
  Hängt einen Teil der Zeichenfolge an dieses Appendable an und liefert es wieder zurück.

Kovariante Rückgabe in Writer von Appendable

Die Klasse Writer demonstriert gut einen kovarianten Rückgabetyp, also dass der Rückgabetyp einer überschriebenen oder implementierten Methode ebenfalls ein Untertyp sein kann. So verfährt auch Writer, der die Schnittstelle Appendable implementiert. Die Methode append(…) in Writer besitzt nicht einfach den Rückgabetyp Appendable aus der Schnittstelle Appendable, sondern konkretisiert ihn zu Writer, was ein Appendable ist.

 

7.2.9Die abstrakte Basisklasse Reader 

Die abstrakte Klasse Reader dient dem Lesen von Zeichen aus einem zeichengebenden Eingabestrom. Die einzigen Methoden, die Unterklassen implementieren müssen, sind read(char[], int, int) und close(). Dies entspricht dem Vorgehen bei den Writer-Klassen, die auch nur close() und write(char[], int, int) implementieren müssen. Eine abstrakte flush()-Methode, wie sie Writer besitzt, kann Reader nicht haben. Es bleiben demnach für die Reader-Klasse zwei abstrakte Methoden übrig. Die Unterklassen implementieren jedoch auch andere Methoden aus Geschwindigkeitsgründen neu.

• protected Reader()
  Erzeugt einen neuen Reader, der sich mit sich selbst synchronisiert.

• protected Reader(Object lock)
  Erzeugt einen neuen Reader, der mit dem Objekt lock synchronisiert ist.

• abstract int read(char[] cbuf, int off, int len) throws IOException
  Liest len Zeichen in den Puffer cbuf ab der Stelle off. Wenn len Zeichen nicht vorhanden sind, wartet der Reader. Die Methode gibt die Anzahl gelesener Zeichen zurück oder –1, wenn das Ende des Stroms erreicht wurde.

• int read(CharBuffer target) throws IOException
  Liest Zeichen in den CharBuffer. Die Methode schreibt die Schnittstelle Readable vor.

• int read() throws IOException
  Die parameterlose Methode liest das nächste Zeichen aus dem Eingabestrom. Sie wartet, wenn kein Zeichen im Strom bereitliegt. Der Rückgabewert ist ein int im Bereich von 0 bis 65.635 (0x0000–0xFFFF). Warum dann der Rückgabewert aber int und nicht char ist, kann leicht damit erklärt werden, dass die Methode den Rückgabewert –1 (0xFFFFFFFF) kodieren muss, falls keine Daten anliegen.

• int read(char[] cbuf) throws IOException
  Liest Zeichen aus dem Strom und schreibt sie in ein Feld. Die Methode wartet, bis Eingaben anliegen. Der Rückgabewert ist die Anzahl der gelesenen Zeichen oder –1, wenn das Ende des Datenstroms erreicht wurde.

• abstract void close() throws IOException
  Schließt den Strom. Folgt anschließend noch ein Aufruf von read(…), mark(int) oder reset(), lösen diese eine IOException aus. Ein doppelt geschlossener Stream hat keinen weiteren Effekt.

Weitere Methoden

Zu diesen notwendigen Methoden, die bei der Klasse Reader gegeben sind, kommen noch weitere interessante Methoden hinzu, die den Status abfragen und Positionen setzen lassen. Die Methode ready() liefert als Rückgabe true, wenn ein read(…) ohne Blockierung der Eingabe möglich ist. Die Standardimplementierung der abstrakten Klasse Reader gibt immer false zurück.

• public boolean ready() throws IOException
  Liefert true, wenn aus dem Stream direkt gelesen werden kann. Das heißt allerdings nicht, dass false immer Blocken bedeutet.

Sprünge und Markierungen

Mit der Methode mark(int) lässt sich eine bestimmte Position innerhalb des Eingabestroms markieren, das heißt, die Methode sichert die Position. Mit beliebigen reset()-Aufrufen lässt sich diese konkrete Stelle zu einem späteren Zeitpunkt wieder anspringen. mark(int) besitzt einen Ganzzahlparameter (int, nicht long), der angibt, wie viele Zeichen gelesen werden dürfen, bevor die Markierung nicht mehr gültig ist. Die Zahl ist wichtig, da sie die interne Größe des Puffers bezeichnet, der für den Strom angelegt werden muss. Nicht jeder Datenstrom unterstützt dieses Hin- und Herspringen. Die Klasse StringReader unterstützt etwa die Markierung einer Position, die Klasse FileReader dagegen nicht. Daher sollte vorher mit markSupported() überprüft werden, ob das Markieren auch unterstützt wird. Wenn der Datenstrom es nicht unterstützt und wir diese Warnung ignorieren, werden wir eine IOException bekommen. Denn Reader implementiert mark(int) und reset() ganz einfach und muss von uns im Bedarfsfall überschrieben werden:

Listing 7.10java/io/Reader.java, Ausschnitt 

Daher gibt markSupported() auch in der Reader-Klasse false zurück.

• long skip(long n) throws IOException
  Überspringt n Zeichen. Blockt, bis Zeichen vorhanden sind. Gibt die Anzahl der wirklich übersprungenen Zeichen zurück.

• boolean markSupported()
  Der Stream unterstützt die mark()-Operation.

• void mark(int readAheadLimit) throws IOException
  Markiert eine Position im Stream. Der Parameter bestimmt, nach wie vielen Zeichen die Markierung ungültig wird, mit anderen Worten: Er gibt die Puffergröße an.

• void reset() throws IOException
  Falls eine Markierung existiert, setzt der Stream an der Markierung an. Wurde die Position vorher nicht gesetzt, dann wird eine IOException mit dem String »Stream not marked« ausgelöst.

Reader implementiert die schon bekannte Schnittstelle Closeable mit der Methode close(). Und so, wie ein Writer die Schnittstelle Appendable implementiert, so implementiert ein Reader die Schnittstelle Readable und damit die Operation int read(CharBuffer target) throws IOException.