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.
  Version:
    $Id$
  Author:
    Chris Poirier

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `LIKELY_ERRORS`
    `static int` | `NONE`
    `static int` | `PARANOIA`
    `static int` | `POSSIBLE_ERRORS`

    - ### Fields inherited from class org.codehaus.groovy.control.messages.LocatedMessage

      `context`

    - ### Fields inherited from class org.codehaus.groovy.control.messages.SimpleMessage

      `data, message, owner`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `WarningMessage(int importance, String message, CSTNode context, SourceUnit owner)` Creates a new warning message.
    `WarningMessage(int importance, String message, Object data, CSTNode context, SourceUnit owner)` Creates a new warning message.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `isRelevant(int importance)` Returns true if this message is as or more important than the specified importance level.
    `static boolean` | `isRelevant(int actual, int limit)` Returns true if a warning would be relevant to the specified level.
    `void` | `write(PrintWriter writer, Janitor janitor)` Writes the message to the specified PrintWriter.

    - ### Methods inherited from class org.codehaus.groovy.control.messages.SimpleMessage

      `getMessage`

    - ### Methods inherited from class org.codehaus.groovy.control.messages.Message

      `create, create, create, write`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### NONE

          public static final int NONE

      See Also:
        Constant Field Values

    - #### LIKELY_ERRORS

          public static final int LIKELY_ERRORS

      See Also:
        Constant Field Values

    - #### POSSIBLE_ERRORS

          public static final int POSSIBLE_ERRORS

      See Also:
        Constant Field Values

    - #### PARANOIA

          public static final int PARANOIA

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### 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 Detail

    - #### 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`