Package org.codehaus.groovy.control.messages

Class WarningMessage

java.lang.Object
org.codehaus.groovy.control.messages.Message
org.codehaus.groovy.control.messages.SimpleMessage
org.codehaus.groovy.control.messages.LocatedMessage
org.codehaus.groovy.control.messages.WarningMessage
public class WarningMessage extends LocatedMessage
A class for warning messages.
Author:
Chris Poirier

  • Field Details

  • Constructor Details

    • WarningMessage

      public WarningMessage(int importance, String message, CSTNode context, SourceUnit owner)
      Creates a new warning message.
      Parameters:
      importance - the warning level
      message - the message text
      context - context information for locating the offending source text

    • WarningMessage

      public WarningMessage(int importance, String message, Object data, CSTNode context, SourceUnit owner)
      Creates a new warning message.
      Parameters:
      importance - the warning level
      message - the message text
      data - additional data needed when generating the message
      context - context information for locating the offending source text

  • Method Details

    • isRelevant

      public static boolean isRelevant(int actual, int limit)
      Returns true if a warning would be relevant to the specified level.

    • isRelevant

      public boolean isRelevant(int importance)
      Returns true if this message is as or more important than the specified importance level.

    • write

      public void write(PrintWriter writer, Janitor janitor)
      Description copied from class: Message
      Writes the message to the specified PrintWriter. The supplied ProcessingUnit is the unit that holds this Message.
      Overrides:
      write in class LocatedMessage