Referenz: java.util.logging.StreamHandler

Weitere aktuelle Java-Titel finden Sie bei dpunkt.

Klasse java.util.logging.StreamHandler

1.4

java.lang.Object
   |
   +--java.util.logging.Handler
         |
         +--java.util.logging.StreamHandler

Deklaration

public class StreamHandler extends java.util.logging.Handler

Beschreibung

Diese Klasse verarbeitet Protokolleinträge indem sie in einem Stream geschrieben werden. Sie wird üblicherweise nicht als eigenständiger Handler benutzt, sondern dient eher als Basis oder Hilfsklasse zur Implementierung eigener Stream-basierter Handler.

Bei der Erzeugung eines StreamHandler werden folgende Properties vom LogManager ermittelt, wenn nicht gesetzt werden die entsprechenden Default-Einstellungen benutzt:

java.util.logging.StreamHandler.level
gibt die Default-Log-Ebene an (voreingestellt ist Level.INFO).
java.util.logging.StreamHandler.filter
gibt den vollqualifizierten Namen der Klasse des Filters an, der benutzt werden soll (per Voreinstellung wird kein Filter benutzt).
java.util.logging.StreamHandler.formatter
gibt den vollqualifizierten Namen der Klasse des Formatieres an, der benutzt werden soll (voreingestellt ist java.util.logging.SimpleFormatter).
java.util.logging.StreamHandler.encoding
gibt den Namen des Zeichensatzes an, in dem die Protokolleinträge geschrieben werden sollen (voreingestellt ist der Default-Zeichensatz der verwendeten Plattform).

Konstruktoren
public	StreamHandler()
public	StreamHandler(OutputStream out, Formatter formatter)

Methoden
public synchronized void	close()
public synchronized void	flush()
public boolean	isLoggable(LogRecord record)
public synchronized void	publish(LogRecord record)
public void	setEncoding(String encoding)
protected synchronized void	setOutputStream(OutputStream out)

Konstruktoren im Detail

public StreamHandler()
Erzeugt einen neuen StreamHandler ohne gesetzen Ausgabe-Stream.

public StreamHandler(OutputStream out, Formatter formatter)
Erzeugt einen neuen StreamHandler mit dem Formatierer formatter und dem Ausgabe-Stream out.

Methoden im Detail

public synchronized void close()

Schließt den aktuellen Ausgabe-Stream. Bevor der Stream geschlossen wird, wird die Abschluß-Zeichenkette des verwendeten Formatierers geschrieben (bei einem XML-Formatierer das abschließende Tag).

Exception: SecurityException

Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission"control" besitzt.

public synchronized void flush()
Schreibt zwischengepufferte Daten heraus.

public boolean isLoggable(LogRecord record)
Liefert den Wert true wenn der übergebene Protokolleintrag in das aktuelle Protokoll aufgenommen werden soll. Die Standard-Implementierung nimmt den Eintrag in das Protokoll auf, wenn die Log-Ebene mindestens so hoch ist, wie die geforderte Log-Ebene, kein gesetzter Filter die Protokollierung untersagt und ein Ausgabe-Stream gesetzt ist.

public synchronized void publish(LogRecord record)
Formatiert und veröffentlicht einen Protokolleintrag. Folgende Voraussetzungen müssen erfüllt sein, damit der Protokolleintrag geschrieben wird: ein gesetzter Ausgabe-Stream. eine Log-Ebene der mindestens so hoch ist, wie der geforderte Log-Ebene. keine Filter, die eine Veröffentlichung untersagen. Wenn alle diese Punkte erfüllt sind, wird der Protokolleintrag über den Formatierer formatiert und in den Ausgabe-Stream geschrieben. Handelt es sich dabei um den ersten Protokolleintrag wird zunächst die Anfangs-Zeichenkette für geschrieben, die eine Menge an Protokolleinträgen einleitet.

public void setEncoding(String encoding)

Setzt den Zeichensatz für die Ausgabe. Der Zeichensatz sollte gesetzt werden, bevor der erste Protokolleintrag geschrieben wird.

Exception: SecurityException

Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission"control" besitzt.

Exception: UnsupportedEncodingException

Wenn der angegebene Zeichensatz nicht unterstützt wird.

protected synchronized void setOutputStream(OutputStream out)

Setzt den Ausgabe-Stream neu. Wenn bereits ein Ausgabe-Stream gesetzt ist, wird die Abschluß-Zeichenkette Formatierers geschrieben, der Stream geleert und geschlossen. Anschließend wird der alte Stream durch den neuen Stream ersetzt.

Exception: SecurityException

Wenn ein SecurityManager gesetzt ist und der Aufruf keine LoggingPermission"control" besitzt.