|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.logging.Handler java.util.logging.StreamHandler
public class StreamHandler
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.
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StreamHandler()
public StreamHandler(OutputStream out, Formatter formatter)
out
- the target output streamformatter
- Formatter to be used to format outputMethod Detail |
---|
protected void setOutputStream(OutputStream out) throws SecurityException
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.
out
- New output stream. May not be null.
SecurityException
- if a security manager exists and if
the caller does not have LoggingPermission("control").public void setEncoding(String encoding) throws SecurityException, UnsupportedEncodingException
The encoding should be set before any LogRecords are written to the Handler.
setEncoding
in class Handler
encoding
- The name of a supported character encoding.
May be null, to indicate the default platform encoding.
SecurityException
- if a security manager exists and if
the caller does not have LoggingPermission("control").
UnsupportedEncodingException
- if the named encoding is
not supported.public void publish(LogRecord record)
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.
record
- description of the log event. A null record is
silently ignored and is not publishedpublic boolean isLoggable(LogRecord record)
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.
isLoggable
in class Handler
record
- a LogRecord
public void flush()
public void close() throws SecurityException
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.
SecurityException
- if a security manager exists and if
the caller does not have LoggingPermission("control").
SecurityException
- if a security manager exists and if
the caller does not have LoggingPermission("control").
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.