Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

StreamHandler

extends Handler

java.lang.Object
↳	java.util.logging.Handler
	↳	java.util.logging.StreamHandler

Known Direct Subclasses

ConsoleHandler , FileHandler , SocketHandler

Class Overview

A StreamHandler object writes log messages to an output stream, that is, objects of the class OutputStream .

A StreamHandler object reads the following properties from the log manager to initialize itself. A default value will be used if a property is not found or has an invalid value.

java.util.logging.StreamHandler.encoding specifies the encoding this handler will use to encode log messages. Default is the encoding used by the current platform.
java.util.logging.StreamHandler.filter specifies the name of the filter class to be associated with this handler. No Filter is used by default.
java.util.logging.StreamHandler.formatter specifies the name of the formatter class to be associated with this handler. Default is java.util.logging.SimpleFormatter .
java.util.logging.StreamHandler.level specifies the logging level. Defaults is Level.INFO .

This class is not thread-safe.

Summary

Public Constructors
	StreamHandler () Constructs a `StreamHandler` object.
	StreamHandler ( OutputStream os, Formatter formatter) Constructs a `StreamHandler` object with the supplied output stream and formatter.

Public Methods
void	close () Closes this handler.
void	flush () Flushes any buffered output.
boolean	isLoggable ( LogRecord record) Determines whether the supplied log record needs to be logged.
synchronized void	publish ( LogRecord record) Accepts a logging request.
void	setEncoding ( String charsetName) Sets the character encoding used by this handler.

Protected Methods
void	setOutputStream ( OutputStream os) Sets the output stream this handler writes to.

[Expand]

Inherited Methods

From class java.util.logging.Handler

abstract void	close () Closes this handler.
abstract void	flush () Flushes any buffered output.
String	getEncoding () Gets the character encoding used by this handler, `null` for default encoding.
ErrorManager	getErrorManager () Gets the error manager used by this handler to report errors during logging.
Filter	getFilter () Gets the filter used by this handler.
Formatter	getFormatter () Gets the formatter used by this handler to format the logging messages.
Level	getLevel () Gets the logging level of this handler, records with levels lower than this value will be dropped.
boolean	isLoggable ( LogRecord record) Determines whether the supplied log record needs to be logged.
abstract void	publish ( LogRecord record) Accepts a logging request and sends it to the the target.
void	reportError ( String msg, Exception ex, int code) Reports an error to the error manager associated with this handler, `ErrorManager` is used for that purpose.
void	setEncoding ( String charsetName) Sets the character encoding used by this handler, `null` indicates a default encoding.
void	setErrorManager ( ErrorManager newErrorManager) Sets the error manager for this handler.
void	setFilter ( Filter newFilter) Sets the filter to be used by this handler.
void	setFormatter ( Formatter newFormatter) Sets the formatter to be used by this handler.
void	setLevel ( Level newLevel) Sets the logging level of the messages logged by this handler, levels lower than this value will be dropped.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public StreamHandler ()

Added in API level 1

Constructs a StreamHandler object. The new stream handler does not have an associated output stream.

public StreamHandler ( OutputStream os, Formatter formatter)

Added in API level 1

Constructs a StreamHandler object with the supplied output stream and formatter.

Parameters

os	the output stream this handler writes to.
formatter	the formatter this handler uses to format the output.

Throws

NullPointerException	if `os` or `formatter` is `null` .

Public Methods

public void close ()

Added in API level 1

Closes this handler. The tail string of the formatter associated with this handler is written out. A flush operation and a subsequent close operation is then performed upon the output stream. Client applications should not use a handler after closing it.

public void flush ()

Added in API level 1

Flushes any buffered output.

public boolean isLoggable ( LogRecord record)

Added in API level 1

Determines whether the supplied log record needs to be logged. The logging levels are checked as well as the filter. The output stream of this handler is also checked. If it is null , this method returns false .

Notice : Case of no output stream will return false .

Parameters

record	the log record to be checked.

Returns

true if record needs to be logged, false otherwise.

public synchronized void publish ( LogRecord record)

Added in API level 1

Accepts a logging request. The log record is formatted and written to the output stream if the following three conditions are met:

the supplied log record has at least the required logging level;
the supplied log record passes the filter associated with this handler, if any;
the output stream associated with this handler is not null .

If it is the first time a log record is written out, the head string of the formatter associated with this handler is written out first.

Parameters

record	the log record to be logged.

public void setEncoding ( String charsetName)

Added in API level 1

Sets the character encoding used by this handler. A null value indicates that the default encoding should be used.

Throws

UnsupportedEncodingException	if `charsetName` is not supported.

Protected Methods

protected void setOutputStream ( OutputStream os)

Added in API level 1

Sets the output stream this handler writes to. If there's an existing output stream, the tail string of the associated formatter will be written to it. Then it will be flushed, closed and replaced with os .

Parameters

os	the new output stream.

Throws

NullPointerException	if `os` is `null` .

Results

Interfaces

Classes

StreamHandler

Class Overview

Summary

Public Constructors

public StreamHandler ()

public StreamHandler ( OutputStream os, Formatter formatter)

Parameters

Throws

Public Methods

public void close ()

public void flush ()

public boolean isLoggable ( LogRecord record)

Parameters

Returns

public synchronized void publish ( LogRecord record)

Parameters

public void setEncoding ( String charsetName)

Throws

Protected Methods

protected void setOutputStream ( OutputStream os)

Parameters

Throws