Stay organized with collections
Save and categorize content based on your preferences.
ConsoleHandler
open class ConsoleHandler : StreamHandler
This Handler publishes log records to System.err. By default the SimpleFormatter is used to generate brief summaries.
Configuration: By default each ConsoleHandler is initialized using the following LogManager configuration properties where <handler-name>
refers to the fully-qualified class name of the handler. If properties are not defined (or have invalid values) then the specified default values are used.
- <handler-name>.level specifies the default level for the Handler (defaults to Level.INFO).
- <handler-name>.filter specifies the name of a Filter class to use (defaults to no Filter).
- <handler-name>.formatter specifies the name of a Formatter class to use (defaults to java.util.logging.SimpleFormatter).
- <handler-name>.encoding the name of the character set encoding to use (defaults to the default platform encoding).
For example, the properties for ConsoleHandler
would be:
- java.util.logging.ConsoleHandler.level=INFO
- java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
For a custom handler, e.g. com.foo.MyHandler, the properties would be:
- com.foo.MyHandler.level=INFO
- com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter
Summary
Public constructors |
Create a ConsoleHandler for System.err.
|
Public methods |
open Unit |
Override StreamHandler.close to do a flush but not to close the output stream.
|
open Unit |
Publish a LogRecord.
|
Inherited functions |
From class StreamHandler
Unit |
flush()
Flush any buffered messages.
|
Boolean |
isLoggable(record: LogRecord!)
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.
|
Unit |
setEncoding(encoding: String!)
Set (or change) the character encoding used by this Handler.
The encoding should be set before any LogRecords are written to the Handler.
|
Unit |
setOutputStream(out: OutputStream!)
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.
|
|
From class Handler
String! |
getEncoding()
Return the character encoding for this Handler.
|
ErrorManager! |
getErrorManager()
Retrieves the ErrorManager for this Handler.
|
Filter! |
getFilter()
Get the current Filter for this Handler.
|
Formatter! |
getFormatter()
Return the Formatter for this Handler.
|
Level! |
getLevel()
Get the log level specifying which messages will be logged by this Handler. Message levels lower than this level will be discarded.
|
Unit |
reportError(msg: String!, ex: Exception!, code: Int)
Protected convenience method to report an error to this Handler's ErrorManager. Note that this method retrieves and uses the ErrorManager without doing a security check. It can therefore be used in environments where the caller may be non-privileged.
|
Unit |
setErrorManager(em: ErrorManager!)
Define an ErrorManager for this Handler.
The ErrorManager's "error" method will be invoked if any errors occur while using this Handler.
|
Unit |
setFilter(newFilter: Filter!)
Set a Filter to control output on this Handler.
For each call of publish the Handler will call this Filter (if it is non-null) to check if the LogRecord should be published or discarded.
|
Unit |
setFormatter(newFormatter: Formatter!)
Set a Formatter. This Formatter will be used to format LogRecords for this Handler.
Some Handlers may not use Formatters, in which case the Formatter will be remembered, but not used.
|
Unit |
setLevel(newLevel: Level!)
Set the log level specifying which message levels will be logged by this Handler. Message levels lower than this value will be discarded.
The intention is to allow developers to turn on voluminous logging, but to limit the messages that are sent to certain Handlers.
|
|
Public constructors
ConsoleHandler
ConsoleHandler()
Create a ConsoleHandler for System.err.
The ConsoleHandler is configured based on LogManager properties (or their default values).
Public methods
close
open fun close(): Unit
Override StreamHandler.close to do a flush but not to close the output stream. That is, we do not close System.err.
publish
open fun publish(record: LogRecord!): Unit
Publish a LogRecord.
The logging request was made initially to a Logger object, which initialized the LogRecord and forwarded it here.
Parameters |
record |
LogRecord!: description of the log event. A null record is silently ignored and is not published |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]