15.5 Basisklassen für die Ein-/Ausgabe

Die Strom-Klassen 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.

15.5.1 Die abstrakten Basisklassen

Die konkreten Eingabe/Ausgabe-Klassen 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).

Die Klassen InputStream und OutputStream bilden die Basisklassen für alle byte-orientierten 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.

15.5.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 byte-orientierten und zeichenorientierten Klassen gegenüber –, und die zweite Tabelle zeigt die wesentlichen Ausgabeklassen.

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

15.5.3 Die abstrakte Basisklasse OutputStream

Der Clou bei allen Datenströmen ist nun, 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 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 class java.io.OutputStream
implements Closeable, Flushable

• 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.

15.5.4 Die Schnittstellen Closeable, AutoCloseable und Flushable

Zwei besondere Schnittstellen, Closeable und Flushable, schreiben Methoden vor, die alle Ressorcen implementieren, die geschlossen und/oder Daten aus einem iternen Puffer herausschreiben sollen.

Closeable

Closeable wird von allen lesenden und schreibenden Datenstrom-Klassen implementiert, die geschlossen werden können. Das sind alle Reader/Writer- und InputStream/OutputStream-Klassen und weitere Klassen wie Socket.

interface java.io.Closeable
extends AutoClosable

• void close() throws IOException
  Schließt den Datenstrom. Einen geschlossenen Strom noch einmal zu schließen, hat keine Konsequenz.

Die Schnittstelle Closeable erweitert seit Java 7 java.lang.AutoCloseable, sodass alles, was Closeable implementiert, damit vom Typ AutoCloseable ist und als Variable bei einem try-mit-Ressorcen verwendet werden kann.

interface java.lang.AutoClosable

• void close() throws Exception
  Schließt den Datenstrom. Einen geschlossenen Strom noch einmal zu schließen, hat keine Konsequenz.

Abbildung 15.6: Das Klassendiagramm zeigt die Verebungsbeziehung zwischen Closeable und AutoCloseable

Flushable

Flushable findet sich nur bei schreibenden Klassen und ist insbesondere bei den Klassen wichtig, die Daten puffern.

interface java.io.Flushable

• void flush() throws IOException
  Schreibt gepufferte Daten in den Strom.

Die Basisklassen Reader und OutputStream implementieren diese Schnittstelle, aber auch Formatter tut dies.

15.5.5 Die 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.

abstract class java.io.InputStream
implements Closeable

• int available() throws IOException
  Gibt die Anzahl der verfügbaren Zeichen im Datenstrom zurück, die sofort ohne Blockierung gelesen werden können.
• 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.
• 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() und markSupported() alle Methoden im Fehlerfall eine IOException auslösen.

15.5.6 Ressourcen aus dem Klassenpfad und aus Jar?Archiven laden

Um Ressourcen wie Grafiken oder Konfigurationsdateien aus Jar-Archiven zu laden, ist die Methode getResourceAsStream() beziehungsweise getResource() ideal. Beide sind Methoden des Class-Objekts. getResource() gibt ein URL-Objekt für die Ressource zurück. Da oft der Inhalt des Datenstroms interessant ist, liefert getResourceAsStream() einen InputStream. Intern wird aber nichts anderes gemacht, als getResource() aufzurufen und mit openStream() ein Eingabe-Objekt zu holen. Nur getResourceAsStream() fängt eine eventuelle IOException ab und liefert dann die Rückgabe null.

Da der Klassenlader die Ressource findet, entdeckt er alle Dateien, die im Pfad des Klassenladers eingetragen sind. Das gilt auch für Jar-Archive, weil dort vom Klassenlader alles verfügbar ist. Konnte die Quelle nicht aufgelöst werden, liefern die Methoden null. Die Methode getResourceAsStream() liefert auch null, wenn die Sicherheitsrichtlinien das Lesen verbieten.

class Classi
{
  InputStream in1 = Classi.class.getResourceAsStream( "kullin_fun.txt" );
  void init()
  {
    InputStream in2 = getClass().getResourceAsStream( "hirse_fun.jpg" );
  }
}

Da zum Nutzen der getResourceXXX()-Methoden ein Class-Objekt nötig ist, zeigt das Beispiel zum einen, dass über Classi.class das Class-Objekt zu bekommen ist, und zum anderen, dass in einer Objektmethode ebenfalls die geerbte Object-Methode getClass() ein Class-Objekt liefert.

15.5.7 Die abstrakte Basisklasse Writer

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

abstract class java.io.Writer
implements Appendable, Closeable, Flushable

• 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 Felds 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.

15.5.8 Die abstrakte Basisklasse Reader

Die abstrakte Klasse Reader dient zum 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.

abstract class java.io.Reader
implements Readable, Closeable

• 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(), ready(), mark() 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 Standard-Implementierung der abstrakten Klasse Reader gibt immer false zurück.

while ( reader.ready() )
  System.out.println( reader.read() );

for ( int c; (c = reader.read()) != –1; )
  System.out.println( (char) c );

abstract class java.io.Reader
implements Readable, Closeable

• 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() lässt sich eine bestimmte Position innerhalb des Eingabestroms markieren. Die Methode sichert dabei die Position. Mit beliebigen reset()-Aufrufen lässt sich diese konkrete Stelle zu einem späteren Zeitpunkt wieder anspringen. mark() besitzt einen Ganzzahl-Parameter, 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() und reset() ganz einfach und muss von uns im Bedarfsfall überschrieben werden:

public void mark( int readAheadLimit ) throws IOException {
  throw new IOException("mark() not supported");
}
public void reset() throws IOException {
  throw new IOException("reset() not supported");
}

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

abstract class java.io.Reader
implements Readable, Closeable

• 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.

Ihr Kommentar

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