6.5 Datenströme filtern und verketten

So wie im alltäglichen Leben Filter beim Kaffee oder bei Fotoapparaten eine große Rolle spielen, so sind sie auch bei Datenströmen zu finden. Immer dann, wenn Daten von einer Quelle gelesen oder in eine Senke geschrieben werden, können Filter die Daten auf dem Weg verändern. Die Java-Bibliothek sieht eine ganze Reihe von Filtern vor, die sich zwischen die Kommunikation schalten können.

Der CipherOutputStream stammt als Einziger aus dem Paket javax.crypto; manche Typen sind aus java.util.zip, und alle anderen stammen aus java.io.

6.5.1 Streams als Filter verketten (verschachteln)

Die Funktionalität der bisher vorgestellten Ein-/Ausgabe-Klassen reicht für den Alltag zwar aus, doch sind Ergänzungen gefordert, die die Fähigkeiten der Klassen erweitern; so zum Beispiel beim Puffern. Da die Programmlogik zur Pufferung mit Daten unabhängig von der Quelle ist, aus der die Daten stammen, findet sich die Pufferung in einer gesonderten Klasse. Java implementiert hier ein bekanntes Muster, das sich Dekorator nennt. Zwei Zeilen sollen dieses Prinzip verdeutlichen, um gepufferte Daten in eine Datei zu schreiben:

Writer fw = new FileWriter( filename );
Writer bw = new BufferedWriter( fw );

Der Konstruktor von BufferedWriter nimmt einen beliebigen anderen Writer auf, denn der Pufferung ist es egal, ob die Daten in eine Datei oder ins Netzwerk geschrieben werden. Das Prinzip ist also immer, dass der Filter einen anderen Strom annimmt, an den er die Daten weitergibt oder von dem er sie holt.

Schauen wir uns die Klassen im Paket java.io genau an, die andere Ströme im Konstruktor entgegennehmen:

• BufferedWriter, PrintWriter, FilterWriter nehmen Writer.
• BufferedReader, FilterReader, LineNumberReader, PushbackReader, StreamTokenizer nehmen Reader.
• BufferedOutputStream, DataOutputStream, FilterOutputStream, ObjectOutputStream,
  OutputStreamWriter, PrintStream, PrintWriter nehmen OutputStream.
• BufferedInputStream, DataInputStream, FilterInputStream, InputStreamReader,
  ObjectInputStream, PushbackInputStream nehmen InputStream.

6.5.2 Gepufferte Ausgaben mit BufferedWriter und BufferedOutputStream

Die Klassen BufferedWriter und BufferedOutputStream haben die Aufgabe, die mittels write() in den Ausgabestrom geleiteten Ausgaben zu puffern. Dies ist immer dann nützlich, wenn viele Schreiboperationen gemacht werden, denn das Puffern macht insbesondere Dateioperationen wesentlich schneller, da so mehrere Schreiboperationen zu einer zusammengefasst werden. Um die Funktionalität eines Puffers zu erhalten, besitzen die Klassen einen internen Puffer, in dem die Ausgaben von write() zwischengespeichert werden. Standardmäßig fasst der Puffer 8.192 Symbole. Er kann aber über einen parametrisierten Konstruktor auf einen anderen Wert gesetzt werden. Erst wenn der Puffer voll ist oder die Methoden flush() oder close() aufgerufen werden, werden die gepufferten Ausgaben geschrieben. Durch die Verringerung der Anzahl tatsächlicher write()-Aufrufe an das externe Gerät erhöht sich die Geschwindigkeit der Anwendung im Allgemeinen deutlich.

Abbildung 6.7: BufferedWriter ist ein Writer und dekoriert einen anderen Writer

Um einen BufferedWriter/BufferedOutputStream anzulegen, gibt es zwei Konstruktoren, denen ein bereits existierender Writer/OutputStream übergeben wird. An diesen Writer/OutputStream wird dann der Filter seinerseits die Ausgaben weiterleiten, insbesondere nach einem Aufruf von flush(), close() oder einem internen Überlauf.

class java.io.BufferedWriter     class java.io.BufferedOutputStream
extends Writer                   extends FilterOutputStream

• BufferedWriter(Writer out)
• BufferedOutputStream(OutputStream out)
  Erzeugt einen puffernden Ausgabestrom mit der Puffergröße von 8.192 Symbolen.
• BufferedWriter(Writer out, int sz)
• BufferedOutputStream(OutputStream out, int size)
  Erzeugt einen puffernden Ausgabestrom mit einer Puffergröße. Ist sie nicht echt größer 0, gibt es eine IllegalArgumentException.

Alle write()- und append()-Methoden sind so implementiert, dass die Daten erst im Puffer landen. Wenn der Puffer voll ist – oder flush() aufgerufen wird –, werden sie an den im Konstruktor übergebenen Writer durchgespült.

Beispiel zum BufferedWriter mit FileWriter und PrintWriter

Ein FileWriter sichert Daten in einer Datei. Ein BufferedWriter soll aber vorher die Daten erst einmal sammeln, sodass sie erst beim Flush an den FileWriter gehen. Der Anwendungsentwickler soll in unserem Beispiel aber nicht direkt den BufferedWriter nutzen, sondern ihn als allgemeinen Writer im Konstruktor von PrintWriter übergeben. Ein PrintWriter besitzt die komfortablen Methoden print(), println() und printf(), sodass wir nicht mehr nur auf write()-Methoden vom Writer angewiesen sind:

Listing 6.13: com/tutego/insel/io/writer/ChainedWriter.java, main()

PrintWriter pw = null;
try
{
  Writer fw = new FileWriter( "charArrayWriterDemoPuffer.txt" );
  Writer bw = new BufferedWriter( fw );
  pw = new PrintWriter( bw );

  for ( int i = 1; i < 10000; i++ )
    pw.println( "Zeile " + i );
}
catch ( IOException e ) {
  System.err.println( "Error creating file!" );
}
finally {
  if ( pw != null )
    pw.close();
}

Zusätzlich bietet die Klasse BufferedWriter die Methode newLine(), die in der Ausgabe eine neue Zeile beginnt. Das Zeichen für den Zeilenwechsel wird aus der Systemeigenschaft line.separator genommen. Da sie intern mit der write()-Methode arbeitet, kann sie eine IOException auslösen.

6.5.3 Gepufferte Eingaben mit BufferedReader/BufferedInputStream

Die Klassen BufferedReader und BufferedInputStream puffern Eingaben. Die Daten werden also zuerst in einen Zwischenspeicher geladen, was insbesondere bei Dateien zu weniger Zugriffen auf den Datenträger führt und so die Geschwindigkeit der Anwendung erhöht.

Die Klassen BufferedReader und BufferedInputStream besitzen je zwei Konstruktoren. Bei einem lässt sich die Größe des internen Puffers angeben. Die Puffergröße beträgt wie beim BufferedWriter/BufferedOutputStream standardmäßig 8.192 Einträge.

class java.io.BufferedReader     class java.io.BufferedInputStream
extends Reader                   extends FilterInputStream

• BufferedReader(Reader in)
• BufferedInputStream(InputStream in)
  Erzeugt einen puffernden Zeichenstrom mit der Puffergröße von 8.192.
• BufferedReader( Reader in, int sz )
• BufferedInputStream(InputStream in, int size)
  Erzeugt einen puffernden Zeichenstrom mit der gewünschten Puffergröße.

Programm zur Anzeige von Dateien

Das folgende Programm implementiert ein einfaches »cat«-Kommando[47](Der kurze Name »cat« stammt von »catenate«, einem Synonym für »concatenate«.) von Unix, um Dateiinhalte über die Standardausgabe auszugeben. Die Dateinamen werden auf der Kommandozeile übergeben:

Listing 6.14: com/tutego/insel/io/stream/cat.java

package com.tutego.insel.io.stream;

import java.io.*;

class cat
{
  public static void main( String[] args )
  {
    for ( String filename : args ) {
      try {
        InputStream in = new BufferedInputStream( new FileInputStream(filename) );

        try {
          for ( int c; (c = in.read()) != –1 /* EOF */; )
            System.out.write( c );
        }
        finally {
          in.close();
        }
      }
      catch ( IOException e ) {
        System.err.println( "cat: Fehler beim Verarbeiten von " + filename );
        System.exit( 1 );
      }
    } // end for
  }
}

Die Dateiangaben nimmt das Programm über die Kommandozeile entgegen; etwa so:

$ java com.tutego.insel.io.stream.cat adam.txt eva.txt

new FileReader(f) new BufferedReader(new FileReader(f))
new FileWriter(f) new BufferedWriter(new FileWriter(f))
new FileInputStream(f) new BufferedInputStream(new FileInputStream(f))
new FileOutputStream(f) new BufferedOutputStream(new FileOutputStream(f))

Zeilen lesen mit BufferedReader und readLine()

Die Klasse BufferedReader stellt die Methode readLine() zur Verfügung, die eine komplette Textzeile liest und als String an den Aufrufer zurückgibt; BufferedOutputStream als byte-orientierte Klasse bietet die Methode nicht an.

class java.io.BufferedReader
extends Reader

• String readLine()
  Liest eine Zeile bis zum Zeilenende und gibt den String ohne die Endzeichen zurück. Die Rückgabe ist null, wenn der Stream am Ende ist.

Da ein BufferedReader Markierungen und Sprünge erlaubt, werden die entsprechenden Methoden von Reader überschrieben.

6.5.4 LineNumberReader zählt automatisch Zeilen mit *

Aus BufferedReader geht direkt die – bisher einzige – Unterklasse LineNumberReader hervor, die Zeilennummern zugänglich macht. Sie verfügt damit natürlich auch über readLine(). Mit getLineNumber() und setLineNumber() lässt sich aber zusätzlich auf die Zeilennummer zugreifen. Dass die Zeilennummer auch geschrieben werden kann, ist sicherlich ungewöhnlich, intern wird aber nur die Variable lineNumber geschrieben; der Datenzeiger wird nicht verändert. Bei jedem read() untersuchen die Methoden, ob im Eingabestrom ein »\n«, »\r« oder eine Folge dieser beiden Zeichen vorkommt. Wenn dies der Fall ist, inkrementieren sie die Variable lineNumber. Zeilennummern beginnen bei 0.

Abbildung 6.8: Die Klassenhierarchie von LineNumberReader

class java.io.LineNumberReader
extends BufferedReader

• LineNumberReader(Reader in)
  Dekoriert einen gegebenen Reader.
• LineNumberReader(Reader in, int sz)
  Dekoriert einen gegebenen Reader mit gegebener Puffer-Größe.
• int getLineNumber()
  Liefert die aktuelle Zeilennummer.
• void setLineNumber(int lineNumber)
  Setzt die aktuelle Zeilennummer.

6.5.5 Daten mit der Klasse PushbackReader zurücklegen *

Die Klassen PushbackReader und PushbackInputStream können schon gelesene Eingaben wieder in den Strom zurücklegen. Das ist nützlich für sogenannte vorausschauende Parser, die eine Wahl anhand des nächsten gelesenen Zeichens treffen. Mit den beiden Klassen kann dieses Vorschau-Zeichen wieder in den Eingabestrom gelegt werden, wenn der Parser den Weg doch nicht verfolgen möchte. Der nächste Lesezugriff liest dann nämlich dieses zurückgeschriebene Zeichen.

Die Filterklassen besitzen einen internen Puffer beliebiger Größe, in dem Symbole gespeichert werden, um sie später zurückholen zu können. Im Folgenden wollen wir uns nur mit dem PushbackReader beschäftigen; die Nutzung der Klasse PushbackInputStream ist ähnlich.

Abbildung 6.9: UML-Diagramm mit den PushbackXXX-Klassen

class java.io.PushbackReader
extends FilterReader

• PushbackReader(Reader in)
  Erzeugt einen PushbackReader aus dem Reader in mit der Puffergröße 1.
• PushbackReader(Reader in, int size)
  Erzeugt einen PushbackReader aus dem Reader in mit der Puffergröße size.

Um ein Zeichen oder eine Zeichenfolge wieder in den Eingabestrom zu legen, wird die Methode unread() ausgeführt.

• public void unread(int c) throws IOException
• public void unread(char[] cbuf, int off, int len) throws IOException
• public void unread(char[] cbuf) throws IOException
  Legt ein Zeichen oder ein Feld von Zeichen zurück in den Zeichenstrom.

PushbackReader ist ein Eingabefilter und die einzige Klasse, die direkt aus FilterReader abgeleitet ist.

Zeilennummern mit einem PushbackReader entfernen

Das nächste Programm demonstriert die Möglichkeiten eines PushbackReaders. Die Implementierung wirkt möglicherweise etwas gezwungen, sie zeigt jedoch, wie unread() eingesetzt werden kann. Das Programm löst folgendes Problem: Wir haben eine Textdatei (im Programm einfach als String über einen StringReader zur Verfügung gestellt), in der Zeilennummern mit dem String verbunden sind.

134Erste Zeile
234Zeile

Wir wollen nun die Zahlen vom Rest der Zeilen trennen. Dazu lesen wir so lange die Zahlen ein, bis ein Zeichen folgt, bei dem Character.isDigit() die Rückgabe false ergibt. Dann wissen wir, dass wir keine Ziffer mehr im Strom haben. Das Problem ist nun, dass zum Testen schon ein Zeichen mehr gelesen werden musste. In einem normalen Programm ohne die Option, das Zeichen zurücklegen zu können, würde das ungemütlich. Dieses Zeichen müsste dann gesondert behandelt werden, da es das erste Zeichen der neuen Eingabe ist und nicht mehr zur Zahl gehört. Doch anstelle dieser Sonderbehandlung legen wir es einfach wieder mit unread() in den Datenstrom, und dann kann der nachfolgende Programmcode einfach so weitermachen, als ob nichts gewesen wäre:

Listing 6.15: com/tutego/insel/io/stream/PushbackReaderDemo.java, main()

String s = "134Erste Zeile\n234Zeile";

PushbackReader in = new PushbackReader( new StringReader(s) );

for ( int c; ; )
{
  try
  {
    int number = 0;

    // Read until no digit

    while ( Character.isDigit((char)(c = in.read())) )
      number = number * 10 + Character.digit( c, 10 );

    if ( c == –1 )         // Ende erreicht? Dann aufhören
      break;

    in.unread( c );        // Gelesenes Zeichen zurücklegen

    System.out.print( number + ":" );

    while ( (c = in.read()) != –1 )
    {
      System.out.print( (char) c );

      if ( c == '\n' )
        break;
    }
    if ( c == –1 )
      break;
  }
  catch ( EOFException e )
  {
    break;
  }
}

PushbackReader und das fehlende readLine()

Da PushbackReader nicht von BufferedReader abgeleitet ist und auch selbst keine Methode readLine() anbietet, müssen wir mit einer kleinen Schleife selbst Zeilen lesen. Im Bedarfsfall muss die Zeichenkombination »\r\n« gelesen werden. So wie die Methode von uns jetzt programmiert ist, ist sie auf Plattformen beschränkt, die nur ein einziges Ende-Zeichen einfügen. Doch warum nutzen wir nicht readLine()? Wer nun auf die Idee kommt, folgende Zeilen zu schreiben, um doch in den Genuss der Methode readLine() zu kommen, ist natürlich auf dem Holzweg:

StringReader   sr = new StringReader( s );
BufferedReader br = new BufferedReader ( sr );
PushbackReader in = new PushbackReader( br );
...
br.readLine();      // Achtung, br!!

Wenn wir dem PushbackReader das Zeichen wiedergeben, dann arbeitet der BufferedReader genau eine Ebene darüber und bekommt vom Zurückgeben nichts mit. Daher ist es sehr gefährlich, die Verkettung zu umgehen. Im konkreten Fall wird das unread() nicht durchgeführt, und das erste Zeichen nach der Zahl fehlt.

6.5.6 DataOutputStream/DataInputStream *

Während der OutputStream nur einzelne Bytes bzw. Byte-Felder schreibt und der InputStream aus einer Eingabe Bytes lesen kann, erweitern die Klassen DataOutputStream und DataInputStream diese Schreib- und Lesefähigkeit um primitive Datentypen. Die Vorgaben bekommen sie aus DataOutput und DataInput, die wir schon bei RandomAccessFile sahen. Wichtige Methoden sind zum Beispiel writeChar(char), writeInt(int), writeUTF(char) oder readUnsignedByte(), readLong() und readFully(byte[]).

6.5.7 Basisklassen für Filter *

Als Basisklassen für existierende Filter – und insbesondere für eigene Filter – sieht die Standardbibliothek folgende Klassen vor:

• FilterInputStream
• FilterOutputStream für die Binärseite
• FilterReader
• FilterWriter für die Zeichenseite

Eine konkrete Filter-Klasse überschreibt nötige Methoden ihrer Basisklassen (also vom InputStream, OutputStream, Reader oder Writer) und ersetzt diese durch neue Methoden mit erweiterter Funktionalität. Die folgende Abbildung stellt die zentralen Filter vor:

Abbildung 6.10: UML-Diagramm mit ausgewählten Filterklassen

Am UML-Diagramm fällt besonders auf, dass jeder Filter zum einen selbst ein Stream ist und zum anderen einen Stream verwaltet. Damit nimmt er Daten entgegen und leitet sie gleich weiter. Das ist ein bekanntes Design-Pattern und nennt sich Dekorator.

6.5.8 Die Basisklasse FilterWriter *

Die Basis für eigene zeichenorientierte Filter, die vor dem Verarbeiten vom Client modifiziert werden sollen, ist die abstrakte Klasse FilterWriter. Wir übergeben im Konstruktor ein Writer-Objekt, an das die späteren Ausgaben weitergeleitet werden. Das Konstruktor-Argument wird in dem protected-Attribut out des FilterWriter-Objekts gesichert. In der Unterklasse greifen wir darauf zurück, denn dorthin schickt der Filter seine Ausgaben.

Die Standardimplementierung der Klasse FilterWriter überschreibt drei der write()-Methoden so, dass die Ausgaben an den im Konstruktor übergebenen Writer gehen.

abstract class java.io.FilterWriter
extends Writer

• protected Writer out
  Der Ausgabestrom, an den die Daten geschickt werden. Er wird dem Konstruktor übergeben, der ihn in out speichert.
• protected FilterWriter(Writer out)
  Erzeugt einen neuen filternden Writer.
• void write(int c)
  Schreibt ein einzelnes Zeichen.
• void write(char[] cbuf, int off, int len)
  Schreibt einen Teil eines Zeichenfelds.
• void write(String str, int off, int len)
  Schreibt einen Teil eines Strings.
• void close()
  Schließt den Stream.
• void flush()
  Leert den internen Puffer des Streams.

Die Klasse ist abstrakt, also können keine direkten Objekte erzeugt werden. Dennoch gibt es einen protected-Konstruktor, der für Unterklassen wichtig ist. Abgeleitete Klassen bieten in der Regel selbst einen Konstruktor mit dem Parameter vom Typ Writer an und rufen im Rumpf mit super(write) den geschützten Konstruktor der Oberklasse FilterWriter auf. Über die initialisierte geschützte Objektvariable out kommen wir dann an diesen Ur-Writer.

6.5.9 Ein LowerCaseWriter *

Wir wollen im Folgenden einen Filter schreiben, der alle in den Strom geschriebenen Zeichen in Kleinbuchstaben umwandelt. Drei Dinge sind für einen eigenen FilterWriter nötig:

• Die Klasse leitet sich von FilterWriter ab.
• Unser Konstruktor nimmt als Parameter ein Writer-Objekt und ruft mit super(out) den Konstruktor der Oberklasse, also FilterWriter, auf. Die Oberklasse speichert das übergebene Argument in der geschützten Objektvariablen out, sodass die Unterklassen darauf zugreifen können.
• Wir überlagern die drei write()-Methoden und eventuell noch close() und flush(). Unsere write()-Methoden führen dann die Filteroperationen aus und geben die wahren Daten an den Writer weiter.

Abbildung 6.11: Vererbungsbeziehungen der neuen Klasse LowerCaseWriter

Listing 6.16: com/tutego/insel/io/stream/LowerCaseWriterDemo.java

package com.tutego.insel.io.stream;

import java.io.*;

class LowerCaseWriter extends FilterWriter
{
  public LowerCaseWriter( Writer writer )
  {
    super( writer );
  }

  @Override
  public void write( int c ) throws IOException
  {
    out.write( Character.toLowerCase((char)c) );
  }

  @Override
  public void write( char[] cbuf, int off, int len ) throws IOException
  {
    out.write( String.valueOf(cbuf).toLowerCase(), off, len );
  }

  @Override
  public void write( String s, int off, int len ) throws IOException
  {
    out.write( s.toLowerCase(), off, len );
  }
}

public class LowerCaseWriterDemo
{
  public static void main( String[] args )
  {
    StringWriter sw = new StringWriter();
    PrintWriter  pw = new PrintWriter( new LowerCaseWriter( sw ) );

    pw.println( "Eine Zeile für klein und groß" );

    System.out.println( sw.toString() );
 }
}

6.5.10 Eingaben mit der Klasse FilterReader filtern *

Wie das Schachteln von Ausgabeströmen, so ist auch das Verbinden mehrerer Eingabeströme möglich. Als abstrakte Basiszwischenklasse existiert hier FilterReader, die ein Reader-Objekt im Konstruktor übergeben bekommt. Dieser sichert das Argument in der protected-Variablen in. (Das ist das gleiche Prinzip wie bei den anderen FilterXXX-Klassen.) Der Konstruktor ist protected, da er von der Unterklasse mit super() aufgerufen werden soll. Standardmäßig leiten die Methoden vom FilterReader die Methoden an den Reader aus der Variablen in weiter; das heißt etwa: Wenn der FilterReader geschlossen wird, wird der Aufruf in.close() ausgeführt. Aus diesem Grund muss der FilterReader auch alle Methoden von Reader überschreiben, da ja eine Umleitung stattfindet.

abstract class java.io.FilterReader
extends Reader

• protected Reader in
  Der Zeicheneingabestrom oder null, wenn der Strom geschlossen wurde.
• protected FilterReader(Reader in)
  Erzeugt einen neuen filternden Reader.

Abbildung 6.12: UML-Diagramm von FilterReader

Die Methoden read(), read(char[] cbuf, int off, int len), skip(long n), ready(), markSupported(), mark(int readAheadLimit), reset() und close() werden überschrieben und leiten die Aufrufe direkt an Reader weiter. Lösen die Methoden eine Ausnahme aus, leitet der FilterReader sie standardmäßig an uns weiter.

6.5.11 Anwendungen für FilterReader und FilterWriter *

Unsere nächste Klasse bringt uns etwas näher an das HTML-Format heran. Wir wollen eine Klasse HTMLWriter entwerfen, die FilterWriter erweitert und Textausgaben in HTML konvertiert. In HTML werden Tags eingeführt, die vom Browser erkannt und besonders behandelt werden. Findet etwa der Browser im HTML-Text eine Zeile der Form <strong>Dick</strong>, so stellt er den Inhalt »Dick« in fetter Schrift dar, da das <strong>-Element den Zeichensatz umstellt. Alle Tags werden in spitzen Klammern geschrieben. Daraus ergibt sich, dass HTML einige spezielle Zeichenfolgen (Entities genannt) verwendet. Wenn diese Zeichen auf der HTML-Seite dargestellt werden, muss dies durch spezielle Zeichensequenzen geschehen.

• < wird zu &lt;
• > wird zu &gt;
• & wird zu &amp;

Kommen diese Zeichen im Quelltext vor, so muss unser HTMLWriter diese Zeichen durch die entsprechende Sequenz ersetzen. Andere Zeichen sollen nicht ersetzt werden.

Den Browsern ist die Struktur der Zeilen in einer HTML-Datei egal. Sie formatieren wiederum nach speziellen Tags. Zeilenvorschübe etwa werden mit <br/> eingeleitet. Unser HTMLWriter soll zwei leere Zeilen durch das Zeilenvorschub-Element <br/> markieren.

HTML-Dokument schreiben

Alle sauberen HTML-Dateien haben einen wohldefinierten Anfang und ein wohldefiniertes Ende. Das folgende kleine HTML-Dokument ist wohlgeformt und zeigt, was unser Programm später erzeugen soll:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
                      "http://www.w3.org/TR/html4/strict.dtd">
<html><head><title>Superkreativer Titel</title></head>
<body><p>
Und eine Menge von Sonderzeichen: &lt; und &gt; und &amp;
Zweite Zeile
<br/>
Leerzeile
Keine Leerzeile danach
</p></body></html>

Der Titel der Seite sollte im Konstruktor übergeben werden können. Hier ist nun das Programm für den HTMLWriter:

Listing 6.17: com/tutego/insel/io/stream/HTMLWriter.java

package com.tutego.insel.io.stream;

import java.io.*;

class HTMLWriter extends FilterWriter
{
  private boolean newLine;

  /**
   * Creates a new filtered HTML writer with a title for the web page.
   *
   * @param out  a Writer object to provide the underlying stream.
   * @throws NullPointerException if <code>out</code> is <code>null</code>
   */
  public HTMLWriter( Writer out, String title )
  {
    super( out );

    try
    {
      out.write( "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\"" +
                 " \"http://www.w3.org/TR/html4/strict.dtd\">\n"  );
      out.write( "<html><head><title>" );
      out.write( title );
      out.write( "</title></head>\n<body><p>\n" );
    }
    catch ( IOException e )
    {
      e.printStackTrace();
    }
  }

  /**
   * Creates a new filtered HTML writer with no title for the web page.
   *
   * @param out  a Writer object to provide the underlying stream.
   */
  public HTMLWriter( Writer out )
  {
    this( out, "" );
  }

  /**
   * Writes a single character.
   */
  @Override
  public void write( int c ) throws IOException
  {
    switch ( c )
    {
      case '<':
        out.write( "&lt;" );
        newLine = false;
        break;
      case '>':
        out.write( "&gt;" );
        newLine = false;
        break;
      case '&':
        out.write( "&amp;" );
        newLine = false;
        break;
      case '\n':
        if ( newLine )
        {
          out.write( "<br/>\n" );
          newLine = false;
        }
        else
          out.write( "\n" );
        newLine = true;
        break;
      case '\r':
        break; // ignore

      default :
        out.write( c );
        newLine = false;
    }
  }

  /**
   * Writes a portion of an array of characters.
   *
   * @param  cbuf Buffer of characters to be written
   * @param  off  Offset from which to start reading characters
   * @param  len  Number of characters to be written
   * @exception   IOException If an I/O error occurs
   */
  @Override
  public void write( char[] cbuf, int off, int len ) throws IOException
  {
    for ( int i = off; i < len; i++ )
      write( cbuf[i] );
  }

  /**
   * Writes a portion of a string.
   *
   * @param  str  String to be written.
   * @param  off  Offset from which to start reading characters
   * @param  len  Number of characters to be written
   * @exception   IOException If an I/O error occurs
   */
  @Override
  public void write( String str, int off, int len ) throws IOException
  {
    for ( int i = off; i < len; i++ )
      write( str.charAt( i ) );
  }

  /**
   * Closes the stream.
   *
   * @throws IOException If an I/O error occurs.
   */
  @Override
  public void close() throws IOException
  {
    try
    {
      out.write( "</p></body></html>" );
    }
    catch ( IOException e )
    {
      e.printStackTrace();
    }
    out.close();
  }
}

Ein Demo-Programm soll die aufbereiteten Daten in einen StringWriter schreiben:

Listing 6.18: com/tutego/insel/io/stream/HTMLWriterDemo.java, main()

StringWriter sw = new StringWriter();
HTMLWriter html = new HTMLWriter( sw, "Superkreativer Titel" );
PrintWriter pw  = new PrintWriter( html );

pw.println( "Und eine Menge von Sonderzeichen: < und > und &" );
pw.println( "Zweite Zeile" );
pw.println();
pw.println( "Leerzeile" );
pw.println( "Keine Leerzeile danach" );
pw.close();

System.out.println( sw.toString() );

HTML-Tags mit einem speziellen Filter überlesen

Unser nächstes Beispiel ist eine Klasse, die den FilterReader so erweitert, dass HTML-Tags überlesen werden. Die Klasse FilterReader deklariert den notwendigen Konstruktor zur Annahme des tiefer liegenden Reader und überschreibt zwei read()-Methoden. Die read()-Methode ohne Parameter – die ein int für ein gelesenes Zeichen zurückgibt – legt einfach ein 1 Zeichen großes Feld an und ruft dann die zweite überschriebene read()-Methode auf, die die Daten in ein Feld liest. Da dieser Methode neben dem Feld auch noch die Größe übergeben werden kann, müssen wirklich so viele Zeichen gelesen werden. Es reicht einfach nicht aus, die übergebene Anzahl von Zeichen vom tiefer liegenden Reader zu lesen, sondern hier müssen wir beachten, dass eingestreute Tags nicht zählen. Die Zeichenkette <p>Hallo<p> ist ja nur fünf Zeichen lang und nicht elf!

Listing 6.19: com/tutego/insel/io/stream/ HTMLReader.java

package com.tutego.insel.io.stream;

import java.io.*;

class HTMLReader extends FilterReader
{
  private boolean intag = false;

  public HTMLReader( Reader in )
  {
    super( in );
  }

  @Override
  public int read() throws IOException
  {
    char[] buf = new char[1];
    return read( buf, 0, 1 ) == –1 ? –1 : buf[0];
  }

  @Override
  public int read( char[] cbuf, int off, int len ) throws IOException
  {
    int numchars = 0;

    while ( numchars == 0 )
    {
      numchars = in.read( cbuf, off, len );

      if ( numchars == –1 ) // EOF?
        return –1;

      int last = off;

      for ( int i = off; i < off + numchars; i++ )
      {
        if ( ! intag )
        {
          if ( cbuf[i] == '<' )
            intag = true;
          else
            cbuf[last++] = cbuf[i];
        }
        else if ( cbuf[i] == '>' )
          intag = false;
      }
      numchars = last – off;
    }
    return numchars;
  }
}

Ein Beispielprogramm soll die Daten aus einem StringReader ziehen. Auf den HTMLReader setzen wir noch einen BufferedReader auf, damit wir die komfortable readLine()-Methode nutzen können:

Listing 6.20: com/tutego/insel/io/stream/HTMLReaderDemo.java, main()

try
{
  String s = "<html>Hallo! <b>Ganz schön fett.</b>"
             + "Ah, wieder normal.</html>";

  Reader sr = new StringReader( s );
  Reader hr = new HTMLReader( sr );
  BufferedReader in = new BufferedReader( hr );

  for ( String line; (line = in.readLine()) != null; )
    System.out.println( line );

  in.close();
}
catch ( Exception e )
{
  e.printStackTrace();
}

Es produziert dann die einfache Ausgabe:

Hallo! Ganz schön fett. Ah, wieder normal.

Ihr Kommentar

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