Class LocalLogs

  • All Implemented Interfaces:
    Logs

    public abstract class LocalLogs
    extends java.lang.Object
    implements Logs
    Stores and retrieves logs in-process (i.e. without any RPCs).
    • Constructor Detail

      • LocalLogs

        protected LocalLogs()
    • Method Detail

      • getNullLogger

        public static LocalLogs getNullLogger()
        Logger which doesn't do anything.
        Returns:
        the null logger
      • getStoringLoggerInstance

        public static LocalLogs getStoringLoggerInstance​(java.util.Set<java.lang.String> logTypesToIgnore)
      • getHandlerBasedLoggerInstance

        public static LocalLogs getHandlerBasedLoggerInstance​(LoggingHandler loggingHandler,
                                                              java.util.Set<java.lang.String> logTypesToInclude)
      • getCombinedLogsHolder

        public static LocalLogs getCombinedLogsHolder​(LocalLogs predefinedTypeLogger,
                                                      LocalLogs allTypesLogger)
        See documentation of CompositeLocalLogs about the difference between the first LocalLogs instance and the second one.
        Parameters:
        predefinedTypeLogger - LocalLogs which pre-defines the log types it stores.
        allTypesLogger - LocalLogs which can store log entries for all log types.
        Returns:
        A LocalLogs instance.
      • get

        public abstract LogEntries get​(java.lang.String logType)
        Description copied from interface: Logs
        Fetches available log entries for the given log type. Note that log buffers are reset after each call, meaning that available log entries correspond to those entries not yet returned for a given log type. In practice, this means that this call will return the available log entries since the last call, or from the start of the session. For more info on enabling logging, look at LoggingPreferences.
        Specified by:
        get in interface Logs
        Parameters:
        logType - The log type.
        Returns:
        Available log entries for the specified log type.
      • addEntry

        public abstract void addEntry​(java.lang.String logType,
                                      LogEntry entry)