Class Message


  • public class Message
    extends java.lang.Object
    Messages to be displayed to the student within a grade report.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String END_OF_ERROR_MARKER
      Used to indicate the end of captured std error messages.
      static java.lang.String END_OF_OUTPUT_LINE  
      static java.lang.String END_OF_OUTPUT_MARKER
      Used to indicate the end of captured output when std err is not also being captured.
      static java.lang.String HTML_PASSTHROUGH
      Alternately begin and ends a section fo text that should be omitted from plain-text messaging and passed unchanged into HTML messages.
      static int MAX_MESSAGE_LENGTH
      All messages are clipped to this length in reports.
      static java.lang.String OUTPUT_ERROR_MARKER
      Used to indicate the end of output amd beginning of captured error messages.
    • Constructor Summary

      Constructors 
      Constructor Description
      Message​(java.lang.String msg)
      Create a new message.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toHTML()
      Render a message for inclusion in an HTML report.
      java.lang.String toString()
      Render a message for inclusion in an HTML report.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • HTML_PASSTHROUGH

        public static final java.lang.String HTML_PASSTHROUGH
        Alternately begin and ends a section fo text that should be omitted from plain-text messaging and passed unchanged into HTML messages.
        See Also:
        Constant Field Values
      • END_OF_OUTPUT_MARKER

        public static final java.lang.String END_OF_OUTPUT_MARKER
        Used to indicate the end of captured output when std err is not also being captured.
        See Also:
        Constant Field Values
      • END_OF_OUTPUT_LINE

        public static final java.lang.String END_OF_OUTPUT_LINE
        See Also:
        Constant Field Values
      • OUTPUT_ERROR_MARKER

        public static final java.lang.String OUTPUT_ERROR_MARKER
        Used to indicate the end of output amd beginning of captured error messages.
        See Also:
        Constant Field Values
      • END_OF_ERROR_MARKER

        public static final java.lang.String END_OF_ERROR_MARKER
        Used to indicate the end of captured std error messages.
        See Also:
        Constant Field Values
      • MAX_MESSAGE_LENGTH

        public static final int MAX_MESSAGE_LENGTH
        All messages are clipped to this length in reports.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Message

        public Message​(java.lang.String msg)
        Create a new message.
        Parameters:
        msg -
    • Method Detail

      • toHTML

        public java.lang.String toHTML()
        Render a message for inclusion in an HTML report.
        Returns:
        message text suitable for pasting into an HTML file
      • toString

        public java.lang.String toString()
        Render a message for inclusion in an HTML report.
        Overrides:
        toString in class java.lang.Object
        Returns:
        message text suitable for pasting into an HTML file