OpenJDK 27 · java.util.logging.ConsoleHandler · APIdia, the JavaDoc alternative

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

Access	Constructor and Description
public	ConsoleHandler() Create a `ConsoleHandler` for `System.err`.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.util.logging.StreamHandler.close. Override `StreamHandler.close` to do a flush but not to close the output stream.
public void	publish(LogRecord description of the log event. A null record is silently ignored and is not published record) Overrides java.util.logging.StreamHandler.publish. Publish a `LogRecord`.

Inherited from java.util.logging.StreamHandler:: flush isLoggable setEncoding setOutputStream synchronousPostWriteHook

Constructor Detail

ConsoleHandler back to summary

ConsoleHandler	back to summary
public ConsoleHandler() Create a `ConsoleHandler` for `System.err`. The `ConsoleHandler` is configured based on `LogManager` properties (or their default values).

public ConsoleHandler()

Create a ConsoleHandler for System.err.

The ConsoleHandler is configured based on LogManager properties (or their default values).

Method Detail

close back to summary

close	back to summary
public void close() Overrides java.util.logging.StreamHandler.close. Override `StreamHandler.close` to do a flush but not to close the output stream. That is, we do not close `System.err`. Annotations @Override

public void close()

Overrides java.util.logging.StreamHandler.close.

Override StreamHandler.close to do a flush but not to close the output stream. That is, we do not close System.err.

Annotations

@Override

publish back to summary

publish	back to summary
public void publish(LogRecord record) Overrides java.util.logging.StreamHandler.publish. Publish a `LogRecord`. The logging request was made initially to a `Logger` object, which initialized the `LogRecord` and forwarded it here. Implementation Specification This method is not synchronized, and subclasses must not define overridden `publish()` methods to be `synchronized` if they call `super.publish()` or format user arguments. See the discussion in java.util.logging.Handler for more information. Parameters record:LogRecord description of the log event. A null record is silently ignored and is not published Annotations @Override

public void publish(LogRecord record)

Overrides java.util.logging.StreamHandler.publish.

Publish a LogRecord.

The logging request was made initially to a Logger object, which initialized the LogRecord and forwarded it here.

Implementation Specification

This method is not synchronized, and subclasses must not define overridden publish() methods to be synchronized if they call super.publish() or format user arguments. See the discussion in java.util.logging.Handler for more information.

Parameters

record:LogRecord: description of the log event. A null record is silently ignored and is not published

Annotations

@Override

public Class ConsoleHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail