Interface IMessage

All Known Implementing Classes:
LintMessage, Message, WeaveMessage
public interface IMessage
Wrap message with any associated throwable or source location.

  • Field Details

  • Method Details

    • getMessage

      String getMessage()
      Returns:
      non-null String with simple message

    • getKind

      IMessage.Kind getKind()
      Returns:
      the kind of this message

    • isError

      boolean isError()
      Returns:
      true if this is an error

    • isWarning

      boolean isWarning()
      Returns:
      true if this is a warning

    • isDebug

      boolean isDebug()
      Returns:
      true if this is an internal debug message

    • isUsage

      boolean isUsage()
      Returns:
      true if this is a compiler usage message

    • isInfo

      boolean isInfo()
      Returns:
      true if this is information for the user

    • isAbort

      boolean isAbort()
      Returns:
      true if the process is aborting

    • isTaskTag

      boolean isTaskTag()
      Returns:
      true if this is a task tag message

    • isFailed

      boolean isFailed()
      Returns:
      true if something failed

    • getDeclared

      boolean getDeclared()
      Caller can verify if this message came about because of a DEOW

    • getID

      int getID()
      Return the ID of the message where applicable, see IProblem for list of valid IDs

    • getSourceStart

      int getSourceStart()
      Return the start position of the problem (inclusive), or -1 if unknown.

    • getSourceEnd

      int getSourceEnd()
      Return the end position of the problem (inclusive), or -1 if unknown.

    • getThrown

      Throwable getThrown()
      Returns:
      Throwable associated with this message, or null if none

    • getSourceLocation

      ISourceLocation getSourceLocation()
      Returns:
      source location associated with this message, or null if none

    • getDetails

      String getDetails()
      Returns:
      Detailed information about the message. For example, for declare error/warning messages this returns information about the corresponding join point's static part.

    • getExtraSourceLocations

      List<ISourceLocation> getExtraSourceLocations()
      Return a List of ISourceLocation instances that indicate additional source locations relevent to this message as specified by the message creator. The list should not include the primary source location associated with the message which can be obtained from getSourceLocation().

      An example of using extra locations would be in a warning message that flags all shadow locations that will go unmatched due to a pointcut definition being based on a subtype of a defining type.

      Returns:
      a list of additional source locations
      See Also:

Copyright © 1997 to present AspectJ contributors. All rights reserved.