Package org.apache.logging.log4j.status
Class StatusConsoleListener
java.lang.Object
org.apache.logging.log4j.status.StatusConsoleListener
- All Implemented Interfaces:
Closeable
,AutoCloseable
,EventListener
,StatusListener
A
StatusListener
that writes to the console.-
Constructor Summary
ConstructorDescriptionStatusConsoleListener
(Level level) Constructs aStatusConsoleListener
instance writing toSystem.out
using the supplied level.StatusConsoleListener
(Level level, PrintStream stream) Constructs aStatusConsoleListener
instance using the supplied level and stream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Resets the level and output stream to its initial values, and closes the output stream, if it is a non-system one.Returns the level for which the listener should receive events.void
log
(StatusData data) Writes status messages to the console.void
setFilters
(String... filters) Deprecated.This method is ineffective and only kept for binary backward compatibility.void
Sets the level to a new value.void
setStream
(PrintStream stream) Sets the output stream to a new value.
-
Constructor Details
-
StatusConsoleListener
Constructs aStatusConsoleListener
instance writing toSystem.out
using the supplied level.- Parameters:
level
- the level of status messages that should appear on the console- Throws:
NullPointerException
- on nulllevel
-
StatusConsoleListener
Constructs aStatusConsoleListener
instance using the supplied level and stream.Make sure not to use a logger stream of some sort to avoid creating an infinite loop of indirection!
- Parameters:
level
- the level of status messages that should appear on the consolestream
- the stream to write to- Throws:
NullPointerException
- on nulllevel
orstream
-
-
Method Details
-
setLevel
Sets the level to a new value.- Parameters:
level
- the new level- Throws:
NullPointerException
- on nulllevel
-
setStream
Sets the output stream to a new value.- Parameters:
stream
- the new output stream- Throws:
NullPointerException
- on nullstream
- Since:
- 2.23.0
-
getStatusLevel
Returns the level for which the listener should receive events.- Specified by:
getStatusLevel
in interfaceStatusListener
- Returns:
- the log level
-
log
Writes status messages to the console.- Specified by:
log
in interfaceStatusListener
- Parameters:
data
- a status data- Throws:
NullPointerException
- on nulldata
-
setFilters
Deprecated.This method is ineffective and only kept for binary backward compatibility.Adds package name filters to exclude.- Parameters:
filters
- An array of package names to exclude.
-
close
public void close()Resets the level and output stream to its initial values, and closes the output stream, if it is a non-system one.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-