Class LogSubscriber


public abstract class LogSubscriber extends Observable
Provides the interfaces for any log subscriber, including custom ones.
  • Constructor Details

    • LogSubscriber

      public LogSubscriber(String name, LogLevel autoSubscribeLevel)
      Creates a new log subscriber with a name and log level.
      name - the name of the log subscriber
      autoSubscribeLevel - the log level to subscribe to
  • Method Details

    • getName

      public String getName()
      Returns the name of this log subscriber.
    • getDescription

      public String getDescription()
      Returns the description of this log subscriber.
    • processMessage

      public abstract void processMessage(LogMessage message)
      Method that is called for each log message that is logged.
      message - the log message to process
    • getAutoSubscribeLevel

      public LogLevel getAutoSubscribeLevel()
      Returns the log level that will be used to automatically subscribe to new log nodes.
    • setAutoSubscribeLevel

      public void setAutoSubscribeLevel(LogLevel level)
      Sets the log level to which to subscribe to automatically.
      level - the log level to set
    • subscribe

      public void subscribe(ILogNode node, LogLevel level)
      Subscribes this subscriber to the specified log node at the specified level.
      node - the log node to subscribe to
      level - the log level at which to subscribe
    • unsubscribe

      public void unsubscribe(ILogNode node)
      Unsubscribes this subscriber from the specified log node.
      node - the log node to subscribe to
    • unsubscribe

      public void unsubscribe()
      Unsubscribes this subscriber from all subscribed log nodes.
    • destroy

      public void destroy()
      Terminates this subscriber and unsubscribes from all log nodes.
    • getSubscriptions

      public Map<ILogNode,LogLevel> getSubscriptions()
      Returns all log nodes that this subscriber subscribed to and the corresponding log levels.