- java.lang.Object
-
- java.util.logging.Handler
-
- java.util.logging.StreamHandler
-
- Direct Known Subclasses:
- ConsoleHandler, FileHandler, SocketHandler
public class StreamHandler extends Handler
Stream based logging Handler.This is primarily intended as a base class or support class to be used in implementing other logging Handlers.
LogRecords are published to a given java.io.OutputStream.
Configuration: By default each StreamHandler is initialized using the following LogManager configuration properties. If properties are not defined (or have invalid values) then the specified default values are used.
- java.util.logging.StreamHandler.level specifies the default level for the Handler (defaults to Level.INFO).
- java.util.logging.StreamHandler.filter specifies the name of a Filter class to use (defaults to no Filter).
- java.util.logging.StreamHandler.formatter specifies the name of a Formatter class to use (defaults to java.util.logging.SimpleFormatter).
- java.util.logging.StreamHandler.encoding the name of the character set encoding to use (defaults to the default platform encoding).
- Since:
- 1.4
-
-
Constructor Summary
Constructors Constructor and Description StreamHandler()
Create a StreamHandler, with no current output stream.StreamHandler(OutputStream out, Formatter formatter)
Create a StreamHandler with a given Formatter and output stream.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Close the current output stream.void
flush()
Flush any buffered messages.boolean
isLoggable(LogRecord record)
Check if this Handler would actually log a given LogRecord.void
publish(LogRecord record)
Format and publish a LogRecord.void
setEncoding(String encoding)
Set (or change) the character encoding used by this Handler.protected void
setOutputStream(OutputStream out)
Change the output stream.-
Methods inherited from class java.util.logging.Handler
getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel
-
-
-
-
Constructor Detail
-
StreamHandler
public StreamHandler()
Create a StreamHandler, with no current output stream.
-
StreamHandler
public StreamHandler(OutputStream out, Formatter formatter)
Create a StreamHandler with a given Formatter and output stream.- Parameters:
out
- the target output streamformatter
- Formatter to be used to format output
-
-
Method Detail
-
setOutputStream
protected void setOutputStream(OutputStream out) throws SecurityException
Change the output stream.If there is a current output stream then the Formatter's tail string is written and the stream is flushed and closed. Then the output stream is replaced with the new output stream.
- Parameters:
out
- New output stream. May not be null.- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
setEncoding
public void setEncoding(String encoding) throws SecurityException, UnsupportedEncodingException
Set (or change) the character encoding used by this Handler.The encoding should be set before any LogRecords are written to the Handler.
- Overrides:
setEncoding
in classHandler
- Parameters:
encoding
- The name of a supported character encoding. May be null, to indicate the default platform encoding.- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").UnsupportedEncodingException
- if the named encoding is not supported.
-
publish
public void publish(LogRecord record)
Format and publish a LogRecord.The StreamHandler first checks if there is an OutputStream and if the given LogRecord has at least the required log level. If not it silently returns. If so, it calls any associated Filter to check if the record should be published. If so, it calls its Formatter to format the record and then writes the result to the current output stream.
If this is the first LogRecord to be written to a given OutputStream, the Formatter's "head" string is written to the stream before the LogRecord is written.
-
isLoggable
public boolean isLoggable(LogRecord record)
Check if this Handler would actually log a given LogRecord.This method checks if the LogRecord has an appropriate level and whether it satisfies any Filter. It will also return false if no output stream has been assigned yet or the LogRecord is null.
- Overrides:
isLoggable
in classHandler
- Parameters:
record
- a LogRecord- Returns:
- true if the LogRecord would be logged.
-
close
public void close() throws SecurityException
Close the current output stream.The Formatter's "tail" string is written to the stream before it is closed. In addition, if the Formatter's "head" string has not yet been written to the stream, it will be written before the "tail" string.
- Specified by:
close
in classHandler
- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/util/logging/streamhandler.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.