14.5 Formatierte Textausgaben

Um mit einem Writer oder OutputStream komfortable Zeichenfolgen – zum Beispiel String-Repräsentationen primitiver Datentypen – zu erzeugen, ist eine Menge Schreibaufwand nötig, da ein einfacher Writer nur Zeichen bzw. Strings und ein simpler OutputStream sogar nur Bytes oder Byte-Folgen schreibt. Dieses Unterkapitel stellt die beiden Klassen PrintWriter und PrintStream vor, die das Erzeugen textueller Ausgaben vereinfachen und das Ergebnis in einen Zielstrom oder in eine Datei schreiben.

14.5.1 Die Klassen PrintWriter und PrintStream

Schon in den ersten Programmen haben wir ein PrintStream-Objekt verwendet – doch vermutlich, ohne es zu wissen. Es steckte im out-Attribut der Klasse System. Typisch für PrintStream und PrintWriter sind die vielen überladenen Methoden namens print(), println(), printf() und format(), die unterschiedliche Datentypen annehmen und eine String-Repräsentation erzeugen. Anders als viele Strom-Klassen erzeugen die Klassen bei Schreibproblemen keine IOException, sondern setzen intern ein Flag, das durch die Methode checkError() nach außen kommt.

PrintWriter out = new PrintWriter( "c:/datei.txt" ); 
out.println( "Hallo Welt!" );

out.print( "Es ist " ); 
out.printf( "%tT Uhr.", new Date() ); 
out.close();

Konstruktoren

Die Konstruktoren von PrintStream und PrintWriter erwarten entweder ein Objekt vom Typ OutputStream, Writer (nur PrintWriter), File oder einen String für den Dateinamen, in dem die Ausgabe geschrieben wird. Mit den beiden zuletzt genannten Konstruktoren wird der PrintWriter/PrintStream nicht als Dekorator um einen existierenden Writer/Stream eingesetzt; es muss also kein FileWriter in den Konstruktor von PrintWriter bzw. FileOutputStream im Konstruktor von PrintStream gesetzt werden, um in eine Datei zu schreiben.

Technisch gesehen ist ein PrintStream eine Unterklasse von FilterOutputStream. (Interessanterweise gilt das für PrintWriter nicht, das direkt eine Unterklasse von Writer ist.)

class java.io.PrintWriter       class java.io.PrintStream 
extends Writer                  extends FilterOutputStream 
                                implements Appendable, Closeable

• PrintWriter( File file ) throws FileNotFoundException

• PrintStream( File file ) throws FileNotFoundException

• PrintWriter( String fileName )

• PrintStream( String fileName )

• PrintWriter( Writer out )

• PrintWriter( OutputStream out )

• PrintStream( OutputStream out )
  Erzeugt einen neuen PrintWriter bzw. PrintStream, der in die angegebene Datei – die entweder durch den Dateinamen oder ein File-Objekt gegeben ist –, den Writer beziehungsweise OutputStream schreibt. Bei einem Zeilenende wird nicht automatisch in den Puffer geschrieben.

Auto-Flush

Die Ausgabe in den PrintWriter und PrintStream ist so lange gepuffert, bis flush() ausgeführt wird. Das Verhalten lässt sich mit einem Schalter ändern, denn einige Konstruktoren nehmen optional ein »Auto-Flush« an, das bestimmt, ob die Daten bei einem println() oder einem printf() bzw. format() mit explizitem »%n« aus dem Puffer gespült werden. So schreibt println("Hallo") auf jeden Fall den String in den Datenstrom, wenn der Konstruktor mit autoFlush gleich true aufgerufen wurde, und keine Daten bleiben im Puffer. Für den PrintStream gilt zusätzlich beim aktivierten Auto-Flush, dass bei jedem Byte »\n« in der Zeichenkette der Puffer geleert wird, also auch bei Zeichen, die über die write()-Methoden geschrieben werden.

class java.io.PrintWriter       class java.io.PrintStream 
extends Writer                  extends FilterOutputStream 
                                implements Appendable, Closeable

• PrintWriter( Writer out, boolean autoFlush )

• PrintWriter( OutputStream out, boolean autoFlush )

• PrintStream( OutputStream out, boolean autoFlush )
  Erzeugt einen neuen PrintWriter beziehungsweise PrintStream, der automatisch bei autoFlush gleich true am Zeilenende mittels println()in den Puffer schreibt.

Konvertierungen

Die Konvertierung in Byte geschieht nach der Standard-Kodierung der Plattform oder wie im Konstruktor angegeben.

class java.io.PrintWriter       class java.io.PrintStream 
extends Writer                  extends FilterOutputStream 
                                implements Appendable, Closeable

• PrintWriter( File file, String csn ) throws FileNotFoundException, UnsupportedEncodingException

• PrintStream( File file, String csn ) throws FileNotFoundException, UnsupportedEncodingException

• PrintWriter( String fileName, String csn ) throws FileNotFoundException, UnsupportedEncodingException

• PrintStream( String fileName, String csn ) throws FileNotFoundException, UnsupportedEncodingException Erzeugt einen neuen PrintWriter zum Schreiben in Dateien mit den angegebenen Kodierungen.

• PrintStream( OutputStream out, boolean autoFlush, String encoding ) throws UnsupportedEncodingException Erzeugt einen PrintStream mit gewünschter Pufferleerung und Zeichenkodierung.

Methodenübersicht

Als Methoden bieten PrintWriter und PrintStream im Wesentlichen das Gleiche: eine Reihe von print(), println(), format(), printf() sowie append()-Methoden aus Appendable.

class java.io.PrintWriter       class java.io.PrintStream 
extends Writer                  extends FilterOutputStream 
                                implements Appendable, Closeable

• void print( boolean | char | char[] | double | float | int | String )
  Schreibt boolean, ein einzelnes Zeichen, ein Array von Zeichen, Fließkommazahlen, Ganzzahlen oder einen String. Ist das Char-Feld null, gibt es eine NullPointerException.

• void print( Object o )
  Ruft o.toString() auf und gibt das Ergebnis aus, wenn o ungleich null ist. Sonst ist die Ausgabe null.

• void println()
  Schreibt Zeilenvorschubzeichen.

• void println( boolean | char | char[] | double | float | int | Object | String )
  Schreibt den Datentyp wie print() und schließt die Zeile mit einem Zeilenendezeichen ab.

• PrintWriter/PrintStream format( Locale l, String format, Object... args )

• PrintWriter/PrintStream format( String format, Object... args )

• PrintWriter/PrintStream printf( Locale l, String format, Object... args )

• PrintWriter/PrintStream printf( String format, Object... args )
  Gibt eine nach dem Formatierungsstring gegebene Zeichenfolge aus. Ist das Format null, folgt eine NullPointerException; bei inkorrektem Formatierungsstring folgt eine IllegalFormatException.

• PrintWriter/PrintStream append( char c )

• PrintWriter/PrintStream append( CharSequence csq )

• PrintWriter/PrintStream append( CharSequence csq, int start, int end )
  Schreibt Zeichen, Felder von Zeichen oder einen String. Die append()-Methoden stammen aus der Schnittstelle Appendable.

• void close()
  Schließt den Stream. Methode aus Closeable.

• void flush()
  Schreibt gepufferte Daten. Aus Flushable.

Der PrintWriter und PrintStream implementieren als typischer Writer und OutputStream noch die write()-Methoden; einmal mit char und einmal mit byte.

Umgang im Fehlerfall

Keine der Methoden löst eine IOException aus (nur die Konstruktoren können eine FileNotFoundException, also eine IOException auslösen). Intern fangen der PrintWriter und PrintStream mögliche IOExceptions ab und setzen ein internes Flag trouble, auf das der Pro-grammablauf jedoch keinen weiteren Einfluss hat. (Daher musste auch die Methode write(String) neu deklariert werden, da die Methode write(String) der Writer-Klasse eine IOException auslöst.) Den Fehlerstatus erfragt checkError().

class java.io.PrintWriter       class java.io.PrintStream 
extends Writer                  extends FilterOutputStream 
                                implements Appendable, Closeable

• boolean checkError()
  Schreibt mit flush() gepufferte Daten und testet, ob intern bei der Verarbeitung eine IOException (außer InterruptedIOException) aufgetreten ist oder manuell setError() aufgerufen wurde. Die Abfrage ist wichtig, da die Klasse keine Ein-/Ausgabe-Exception auslöst.

• protected void setError()
  Setzt den Fehlerstatus auf true. Mit der protected-Methode können Unterklassen eines PrintWriter den Fehlerstatus setzen, den checkError() einbezieht.

• protected void clearError()
  Löscht den internen Fehlerstatus.

14.5.2 System.out, System.err und System.in

Für die Standardeingabe- und Ausgabegeräte, die normalerweise Tastatur und Bildschirm sind, sind Stream-Exemplare vorgesehen, die beim Laden der Klasse System automatisch erzeugt und von uns genutzt werden können. Dies ist zum einen das Objekt hinter System.in für die Eingabe und zum anderen das Objekt System.out für die Ausgabe. System.in ist ein Exemplar der Klasse InputStream (genauer gesagt vom Typ BufferedInputStream), und System.out beziehungsweise System.err ist ein Exemplar von PrintStream.

final class java.lang.System

• static final InputStream in
  Dies ist der Standardeingabestrom. Er ist immer geöffnet und nimmt die Benutzereingaben normalerweise über die Tastatur entgegen.

• static final PrintStream out
  Der Standardausgabestrom. Er ist immer geöffnet und normalerweise mit der Bildschirmausgabe verbunden.

• static final PrintStream err
  Der Standard-Fehlerausgabestrom. Er wurde eingeführt, um die Fehlermeldungen von den Ausgabemeldungen zu unterscheiden. Auch wenn der Ausgabekanal umgeleitet wird, bleiben diese Meldungen erreichbar.

PrintWriter o = new PrintWriter( System.out );

Schreibarbeit sparen

Natürlich ist es Schreibarbeit, immer System.out.printXXX() angeben zu müssen, so wie in:

System.out.println( "Das Programm gibt die Ausgabe:" ); 
System.out.println( 1.234 ); 
System.out.println( "Die drei Fragezeichen sind toll." );

Eine Möglichkeit besteht darin, das statische import zu nutzen. Doch auch mit einem Verweis können wir uns Arbeit sparen. Das Ganze funktioniert, da System.out ein Objekt vom Typ PrintStream ist.

final PrintStream o = System.out; 
o.println( "Neu!" ); 
o.println( "Jetzt noch weniger zu schreiben." ); 
o.println( "Hilft auch Gelenken wieder auf die Sprünge!" );

Ströme umlenken

Die Ströme hinter System.out, System.err und System.in sind vom Laufzeitsystem vorbelegt und lassen sich ändern. Dazu definiert die Klasse System drei statische Funktionen:

final class java.lang.System

• static void setOut( PrintStream out )

• static void setErr( PrintStream err )
  Der Standardausgabekanal/Fehlerkanal wird auf den angegebenen PrintStream gesetzt.

• static void setIn( InputStream in )
  Der Eingabestrom kann umgesetzt werden, um beispielsweise aus einer Datei oder Netzwerkverbindung Daten zu beziehen, die an in anliegen sollen.

Für Applikationen ist es nur möglich, über die drei genannten Methoden die Standardeingabe auf einen beliebigen InputStream und die Standardausgabe auf einen beliebigen PrintStream umzuleiten. Sehr erstaunlich in der System-Klasse ist die Tatsache, dass die Attribute in, out und err final sind und daher eigentlich nicht geändert werden können. Hier greift Sun tief in die Trickkiste.

Den Bildschirm löschen und Textausgaben optisch aufwerten

Die Java-Umgebung setzt keine spezielle grafische Architektur voraus und kein spezielles Terminal. Als systemunabhängige Programmiersprache bietet Java außer der einfachen Textausgabe keine Möglichkeit, die Farben für die Textzeichen zu ändern, den Cursor zu setzen oder den Bildschirm zu löschen.

Ein VT100-Terminal speichert neben dem Text auch Attribute, und es existieren unterschiedliche Kontrollsequenzen, sodass die Konsole Text formatiert ausgegeben kann. Wir können bei einem VT100-Terminal Kontrollzeichen über System.out ausgeben und so zum Beispiel den Bildschirm löschen.

System.out.println( "\u001b[H\u001b[2J" );

Diese Kontrollzeichen sind kryptisch, und so gibt es eine Curses-Bibliothek, mit der Entwickler auf einem VT100-Terminal Zeichenattribute auf der Konsole ändern, den Cursor zum Wandern bringen und einfache ASCII-Fenster erstellen können. Unter Unix implementiert ncurses die Funktionalität – unter Windows gibt es Vergleichbares als PDCurses. Zwei bekanntere Open-Source-Bibliotheken bieten Java Zugriff auf die Curses-Bibliothek: CHARVA (http://www.pitman.co.za/projects/charva/) und Jcurzez (http://www.nongnu.org/jcurzez/).

14.5.3 Geschützte Passwort-Eingaben mit der Klasse Console

Neu in Java 6 ist die Klasse java.io.Console, von der System.console() ein aktuelles Exemplar liefert – oder null bei einem System ohne Konsolenmöglichkeit. Das Console-Objekt ermöglicht übliche Ausgaben und Eingaben und insbesondere mit readPassword() eine Möglichkeit zur Eingabe ohne Echo der eingegebenen Zeichen.

if ( System.console() != null ) 
{ 
  String passwd = new String( System.console().readPassword() ); 
  System.out.println( passwd ); 
}

Ihr Kommentar