Package COM.activesw.api.util

Class MessageSet

  • public class MessageSet
extends java.lang.Object

    Description

    Represents a collection of messages.

    Lifecycle

    This is a lightweight data object.

    Properties

    Property name Type Description
    messages Message The set of messages.
    topMessage String The top level message to use.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String[] levels_1  
      protected static java.lang.String[] levels_n  
      protected static java.lang.String[] long_levels  
      protected java.util.Vector messages
      A vector of Messages.
      protected static java.lang.String newline  
      protected java.lang.String top_message
      The top level message.

    • Constructor Summary

      Constructors 
      Constructor Description
      MessageSet()
      Creates a message set.
      MessageSet​(java.lang.String top_message)
      Creates a message set.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMessage​(Message msg)
      Add a message.
      void addMessages​(MessageSet msg_set)
      Add messages from another MessageSet.
      java.util.Vector getMessages()
      Get the messages.
      int getNumMessages​(int min_severity)
      Get the number of messages at a given severity or higher.
      java.lang.String getTopMessage()
      Get the top level message.
      void setTopMessage​(java.lang.String top_message)
      Set the top level message.
      java.lang.String toLongString​(int min_severity)
      Get a full length string.
      java.lang.String toShortString​(int min_severity)
      Get a short length string.
      java.lang.String toString()
      Calls toShortString(int)(0).
      java.lang.String toSummaryString​(int min_severity)
      Get a string with just a summary.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • newline

        protected static final java.lang.String newline

      • levels_1

        protected static java.lang.String[] levels_1

      • levels_n

        protected static java.lang.String[] levels_n

      • long_levels

        protected static java.lang.String[] long_levels

      • messages

        protected java.util.Vector messages
        A vector of Messages.

      • top_message

        protected java.lang.String top_message
        The top level message.

    • Constructor Detail

      • MessageSet

        public MessageSet()
        Creates a message set.

      • MessageSet

        public MessageSet​(java.lang.String top_message)
        Creates a message set.

    • Method Detail

      • addMessage

        public void addMessage​(Message msg)
        Add a message.
        Throws:
        java.lang.NullPointerException - If msg is null.

      • addMessages

        public void addMessages​(MessageSet msg_set)
        Add messages from another MessageSet.
        Throws:
        java.lang.NullPointerException - If msg_set is null.

      • getNumMessages

        public int getNumMessages​(int min_severity)
        Get the number of messages at a given severity or higher.

      • getMessages

        public java.util.Vector getMessages()
        Get the messages.

      • getTopMessage

        public java.lang.String getTopMessage()
        Get the top level message.

      • setTopMessage

        public void setTopMessage​(java.lang.String top_message)
        Set the top level message.

      • toString

        public java.lang.String toString()
        Calls toShortString(int)(0).
        Overrides:
        toString in class java.lang.Object

      • toSummaryString

        public java.lang.String toSummaryString​(int min_severity)
        Get a string with just a summary. Only pays attention to messages of the given severity or higher.

      • toShortString

        public java.lang.String toShortString​(int min_severity)
        Get a short length string.

      • toLongString

        public java.lang.String toLongString​(int min_severity)
        Get a full length string.