Skip to content

Most visited

Recently visited

navigation
Added in API level 1

StreamHandler

public class StreamHandler
extends Handler

java.lang.Object
   ↳ java.util.logging.Handler
     ↳ java.util.logging.StreamHandler
Known Direct Subclasses


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.

Summary

Public constructors

StreamHandler()

Create a StreamHandler, with no current output stream.

StreamHandler(OutputStream out, Formatter formatter)

Create a StreamHandler with a given Formatter and output stream.

Public methods

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 methods

void setOutputStream(OutputStream out)

Change the output stream.

Inherited methods

From class java.util.logging.Handler
From class java.lang.Object

Public constructors

StreamHandler

Added in API level 1
StreamHandler ()

Create a StreamHandler, with no current output stream.

StreamHandler

Added in API level 1
StreamHandler (OutputStream out, 
                Formatter formatter)

Create a StreamHandler with a given Formatter and output stream.

Parameters
out OutputStream: the target output stream
formatter Formatter: Formatter to be used to format output

Public methods

close

Added in API level 1
void close ()

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.

Throws
SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").

flush

Added in API level 1
void flush ()

Flush any buffered messages.

isLoggable

Added in API level 1
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.

Parameters
record LogRecord: a LogRecord
Returns
boolean true if the LogRecord would be logged.

publish

Added in API level 1
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.

Parameters
record LogRecord: description of the log event. A null record is silently ignored and is not published

setEncoding

Added in API level 1
void setEncoding (String encoding)

Set (or change) the character encoding used by this Handler.

The encoding should be set before any LogRecords are written to the Handler.

Parameters
encoding String: 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.

Protected methods

setOutputStream

Added in API level 1
void setOutputStream (OutputStream out)

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 OutputStream: New output stream. May not be null.
Throws
SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.