Package eu.bandm.tools.message

Class MessageCounter

java.lang.Object
eu.bandm.tools.message.MessageCounter
All Implemented Interfaces:
MessageReceiver<Message>
public class MessageCounter extends Object implements MessageReceiver<Message>
Counts all received messages, per kind, in total, and per critical/non-critical.

  • Field Details

    • counters

      protected Map<Message.Kind,MessageCounter.Counter> counters
      Collection of counters for the different message kinds.

    • countCritical

      protected int countCritical
      Counts the critical errors, that are erros and failures.

    • criticalMark

      protected int criticalMark
      Memorizes the number of critical errors at the beginning of one processing phase, to compare it with the number at the end of that phase.

    • noErrors

      public static final MessageReceiver<Message> noErrors
      Discards all messages but throws an AssertionError if an error is received. Used for initialization code on constant input data which is asserted to run without errors and for which no message output is needed/requested. Throws AssertionError if an Error or a Failure is received.

  • Constructor Details

    • MessageCounter

      public MessageCounter()
      Only constructor.

  • Method Details

    • getCounts

      public int getCounts(Message.Kind kind)
      Returns the count of messages of the given Message.Kind it has received since its creation or the last call to resetCounters()
      Parameters:
      kind - the kind for which the messages shall be counted
      Returns:
      the number of received messages with the given kind.

    • getSum

      public int getSum()
      Returns the count of all messages it has received since its creation or the last call to resetCounters()
      Returns:
      count of all messages received.

    • markCriticalErrors

      public int markCriticalErrors()
      Stores the number of critical errors for later retrieval by getMarkedErrors(). This is usually called at the beginnig of a particular processing phase.
      Returns:
      the current total number of received critical errors.

    • getMarkedErrors

      public int getMarkedErrors()
      Returns the number of new critical errors occured after the last call to markCriticalErrors()
      Returns:
      the number of critical errors received after calling markCriticalErrors().

    • getCriticalCount

      public int getCriticalCount()
      Returns the count of all critical messages it has received since its creation or the last call to resetCounters(). Critical messages are those the kind of which is critical.
      Returns:
      total number of critical errors.
      See Also:

    • hasCriticals

      public boolean hasCriticals()
      Returns whether critical messages have received since its creation or the last call to resetCounters(). Critical messages are those the kind of which is critical.
      Returns:
      if critical errors have been received.
      See Also:

    • resetCounter

      public void resetCounter(Message.Kind k)
      Restart the counter for one particular Message.Kind at zero. Also re-adjust critical count.
      Parameters:
      k - the kind for which the counter shall be resetted.

    • resetCounters

      public void resetCounters()
      Restart all counters at zero, as if the counter object had just been created.

    • receive

      public void receive(Message message)
      Advance one or two counters, depending on the message kind.
      Specified by:
      receive in interface MessageReceiver<Message>
      Parameters:
      message - the message to receive.

    • _toString

      protected String _toString(boolean filter)
      Auxiliary method.
      Parameters:
      filter - whether to suppress the counters with value =0
      Returns:
      text representation of all (or filtered) counter values.

    • toString

      public String toString()
      Deliver a simple, English-based text representation of all counters.
      Overrides:
      toString in class Object
      Returns:
      text representation of all counter values.

    • nonZeroToString

      public String nonZeroToString()
      Deliver a simple, English-based text representation, only mentioning non-zero counters.
      Returns:
      text representation of all non-zero counter values.

    • terminateApplicationOnErrors

      public void terminateApplicationOnErrors()
      Print an (English) text to std err and terminate application with result code {code ==1}, iff errors or failures have been counted.