public interface LogEntryDispatcher
This interface defines the contract for classes that dispatch log entries to registered handlers.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddLogEntryHandler(LogEntryHandler handler) Adds a handler for log entry events.Get theLogEntryFilter.Get the registered log entry handlers.voidremoveLogEntryHandler(LogEntryHandler handler) Removes a previously added log entry handler.voidsetFilter(LogEntryFilter filter) Sets theLogEntryFilterfor log entry events.
-
Method Details
-
addLogEntryHandler
Adds a handler for log entry events. The handler will be invoked whenever a log entry is received.- Parameters:
handler- The log entry handler to be added.
-
removeLogEntryHandler
Removes a previously added log entry handler. The handler will no longer be invoked for any log entries.- Parameters:
handler- The log entry handler to be removed.
-
setFilter
Sets theLogEntryFilterfor log entry events.Only entries that pass the filter will be dispatched to handlers.
- Parameters:
filter- The filter to be set for log entry events.
-
getFilter
LogEntryFilter getFilter()Get theLogEntryFilter.- Returns:
- the filter in use
-
getLogEntryHandlers
Collection<LogEntryHandler> getLogEntryHandlers()Get the registered log entry handlers. Note that implementations usually hold weak references to the handlers, so unused handlers may already have been removed from the list.- Returns:
- collection containing the registered log entry handlers
-