| |
|
| java.lang.Object
 java.util.logging.Handler
java.util.logging.StreamHandler
All known Subclasses: java.util.logging.FileHandler, java.util.logging.SocketHandler, java.util.logging.ConsoleHandler,
| StreamHandler | | public class StreamHandler extends Handler (Code) | | 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).
version:
1.26, 05/05/07
since:
1.4 |
| Method Summary | |
| public synchronized void | close()
Close the current output stream.
The Formatter's "tail" string is written to the stream before it
is closed. | | public synchronized void | flush()
Flush any buffered messages. | | 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. | | public synchronized 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. | | public void | setEncoding(String encoding)
Set (or change) the character encoding used by this Handler. | | protected synchronized 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 - New output stream. |
| StreamHandler | | public StreamHandler()(Code) | | Create a StreamHandler, with no current output stream.
|
| StreamHandler | | public StreamHandler(OutputStream out, Formatter formatter)(Code) | | Create a StreamHandler with a given Formatter
and output stream.
Parameters:
out - the target output stream
Parameters:
formatter - Formatter to be used to format output |
| close | | public synchronized void close() throws SecurityException(Code) | | 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.
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
| flush | | public synchronized void flush()(Code) | | Flush any buffered messages.
|
| isLoggable | | public boolean isLoggable(LogRecord record)(Code) | | 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 - a LogRecord true if the LogRecord would be logged. |
| publish | | public synchronized void publish(LogRecord record)(Code) | | 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 - description of the log event. A null record issilently ignored and is not published |
| setEncoding | | public void setEncoding(String encoding) throws SecurityException, java.io.UnsupportedEncodingException(Code) | | 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 - The name of a supported character encoding.May be null, to indicate the default platform encoding.
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control").
exception:
UnsupportedEncodingException - if the named encoding isnot supported. |
| setOutputStream | | protected synchronized void setOutputStream(OutputStream out) throws SecurityException(Code) | | 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.
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
|
|
|