| java.lang.Object java.util.logging.Handler java.util.logging.StreamHandler
All known Subclasses: java.util.logging.SocketHandler, java.util.logging.ConsoleHandler, java.util.logging.FileHandler,
StreamHandler | public class StreamHandler extends Handler (Code) | | A StreamHandler object writes log messages to an output
stream, that is, an object of type java.io.OutputStream .
A StreamHandler reads the following properties from the log
manager to initialize itself:
- java.util.logging.StreamHandler.encoding - the name of the character set
encoding. Default is the encoding used by the current platform.
- java.util.logging.StreamHandler.filter - the name of the
Filter class. No Filter is used by default.
- java.util.logging.StreamHandler.formatter - the name of the
Formatter class. Default is
java.util.logging.SimpleFormatter .
- java.util.logging.StreamHandler.level - the log level for this
Handler . Default is Level.INFO .
This class is not thread-safe.
|
Method Summary | |
void | close(boolean closeStream) Closes this handler, but the underlying output stream is only closed when
closeStream is true . | public void | close() Closes this handler. | public void | flush() Flushes any buffered output. | void | internalSetOutputStream(OutputStream newOs) Sets the output stream this handler writes to. | public boolean | isLoggable(LogRecord record) Determines whether the supplied log record need to be logged. | public synchronized void | publish(LogRecord record) Accepts an actual logging request. | public void | setEncoding(String encoding) Sets the character encoding used by this handler. | protected void | setOutputStream(OutputStream os) Sets the output stream this handler writes to. |
StreamHandler | public StreamHandler()(Code) | | Constructs a StreamHandler object. The new stream handler
does not have an associated output stream.
|
StreamHandler | StreamHandler(OutputStream os)(Code) | | Constructs a StreamHandler object with the supplied output
stream. Default properties are read.
Parameters: os - the output stream this handler writes to |
StreamHandler | StreamHandler(String defaultLevel, String defaultFilter, String defaultFormatter, String defaultEncoding)(Code) | | Constructs a StreamHandler object. Specified default
values will be used if the corresponding properties are found in log
manager's properties.
|
StreamHandler | public StreamHandler(OutputStream os, Formatter formatter)(Code) | | Constructs a StreamHandler object with the supplied output
stream and formatter.
Parameters: os - the output stream this handler writes to Parameters: formatter - the formatter this handler uses to format the output |
close | void close(boolean closeStream)(Code) | | Closes this handler, but the underlying output stream is only closed when
closeStream is true . Security is not
checked.
Parameters: closeStream - whether to close the underlying output stream |
close | public void close()(Code) | | Closes this handler. The tail string of the formatter associated with
this handler will be written out. A flush operation a subsequent close
operation will then be performed upon the outputstream. Client
applications should not use a handler after closing it.
throws: SecurityException - If a security manager determines that the caller does nothave the required permission. |
flush | public void flush()(Code) | | Flushes any buffered output.
|
internalSetOutputStream | void internalSetOutputStream(OutputStream newOs)(Code) | | Sets the output stream this handler writes to. Note it does nothing else.
Parameters: newOs - the new output stream |
isLoggable | public boolean isLoggable(LogRecord record)(Code) | | Determines whether the supplied log record need to be logged. The logging
levels will be checked as well as the filter. The output stream of this
handler is also checked. If it's null, this method returns false.
Parameters: record - the log record to be checked true if the supplied log record need to be logged,otherwise false |
publish | public synchronized void publish(LogRecord record)(Code) | | Accepts an actual logging request. The log record will be 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 need to be written out, the head
string of the formatter associated with this handler will be written out
first.
Parameters: record - the log record to be logged |
setOutputStream | protected void setOutputStream(OutputStream os)(Code) | | 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 and closed.
Parameters: os - the new output stream throws: SecurityException - If a security manager determines that the caller does nothave the required permission. |
|
|