Package com.biglybt.pif.logging
Interface Logger
- All Known Implementing Classes:
LoggerImpl
public interface Logger
Logging utilities class
- Since:
- 2.0.7.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAlertListener
(LogAlertListener listener) Add a listener to be informed of any alerts to be displayed to users.void
addAlertListener
(LoggerAlertListener listener) Add LoggerAlertListener for all alerts raised.void
addFileLoggingListener
(FileLoggerAdapter listener) getChannel
(String name) Create a normal logging channel.Retrieve all the channels that have been created for all plugins.getNullChannel
(String name) Create a logger channel that doesn't output to the standard AZ log.Retrieve the PluginInterfacegetTimeStampedChannel
(String name) Create a timestamped logging channel.void
removeAlertListener
(LogAlertListener listener) Remove a previously added alert listener.void
removeAlertListener
(LoggerAlertListener listener) Remove previously added AlertListener.void
removeFileLoggingListener
(FileLoggerAdapter listener)
-
Method Details
-
getChannel
Create a normal logging channel. Multiple calls to this method with the same name parameter results in different channels.- Parameters:
name
- Name of LoggerChannel- Returns:
- a new LoggerChannel
- Since:
- 2.0.7.0
-
getTimeStampedChannel
Create a timestamped logging channel. Multiple calls to this method with the same name parameter results in different channels.- Parameters:
name
- Name of LoggerChannel- Returns:
- a new LoggerChannel
- Since:
- 2.3.0.0
-
getNullChannel
Create a logger channel that doesn't output to the standard AZ log. Add listeners to it if output needs to be routed somewhere. Multiple calls to this method with the same name parameter results in different channels- Parameters:
name
- Name of LoggerChannel- Returns:
- a new LoggerChannel
- Since:
- 2.3.0.0
-
getChannels
LoggerChannel[] getChannels()Retrieve all the channels that have been created for all plugins.- Returns:
- Array of LoggerChannel objects
- Since:
- 2.1.0.0
-
getPluginInterface
PluginInterface getPluginInterface()Retrieve the PluginInterface- Returns:
- PluginInterface object
- Since:
- 2.3.0.0
-
addAlertListener
Add LoggerAlertListener for all alerts raised. It might be a better idea to useaddAlertListener(LogAlertListener)
, as it is more flexible.- Parameters:
listener
- Listener to add- Since:
- 2.3.0.6
- See Also:
-
removeAlertListener
Remove previously added AlertListener.- Parameters:
listener
- LoggerAlertListener to remove- Since:
- 2.3.0.6
-
addAlertListener
Add a listener to be informed of any alerts to be displayed to users.- Since:
- 3.1.1.1
-
removeAlertListener
Remove a previously added alert listener.- Since:
- 3.1.1.1
-
addFileLoggingListener
-
removeFileLoggingListener
-