: Interface IReportMessage

Overview

Package

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.togethersoft.sca.core.plugin.report
Interface IReportMessage

All Known Implementing Classes:: ReportMessage

public interface IReportMessage

Author:: Sergey Gorelkin

Method Summary

IAnalyzerDescriptor getAnalyzer()
          Returns the descriptor of the code analyzer that produced this message.

int getAstObjectKind()
          Returns this object's kind, encoded as an integer.

java.lang.String getCompilationUnitName()
          Returns the CompilationUnit object name from message location.

int getEndColumn()
          Returns the end column number of the the element for which this message was produced.

int getEndLine()
          Returns the end line number of the the element for which this message was produced.

java.lang.String getFileName()
          Returns the name of the source file containing the element for which this message was produced.

java.lang.String getMessage()
          Returns the unformatted text of this message.

java.lang.String getMethodName()
          Returns the Method object name from message location.

java.lang.String getPackageName()
          Returns the Package object name from message location.

java.lang.String getProblemSeverity()
          Returns the text description of the severity of the problem that caused this message.

java.lang.String getProjectName()
          Returns the Package object name from message location.

int getStartColumn()
          Returns the start column number of the the element for which this message was produced.

int getStartLine()
          Returns the start line number of the the element for which this message was produced.

IReportMessage[] getSubMessages()
          Method getSubMessages.

java.lang.String getTypeName()
          Returns the Type object name from message location.

Method Detail

getAnalyzer

public IAnalyzerDescriptor getAnalyzer()

Returns the descriptor of the code analyzer that produced this message. Returns null if this message is not associated with any code analyzer.

Returns:: the descriptor of the code analyzer that produced this message.

getAstObjectKind

public int getAstObjectKind()

Returns this object's kind, encoded as an integer.

getCompilationUnitName

public java.lang.String getCompilationUnitName()

Returns the CompilationUnit object name from message location. Returns null if location doesn't contains CompilationUnit object.

Returns:: String name

getEndColumn

public int getEndColumn()

Returns the end column number of the the element for which this message was produced. Returns zero (0) if this message is not associated with any source fragment.

getEndLine

public int getEndLine()

Returns the end line number of the the element for which this message was produced. Returns zero (0) if this message is not associated with any source fragment.

getFileName

public java.lang.String getFileName()

Returns the name of the source file containing the element for which this message was produced. Returns an empty string ("") if this message is not associated with any source file.

getMessage

public java.lang.String getMessage()

Returns the unformatted text of this message.

Returns:: the text of this message.

getMethodName

public java.lang.String getMethodName()

Returns the Method object name from message location. Returns null if location doesn't contains Method object.

Returns:: String name

getPackageName

public java.lang.String getPackageName()

Returns the Package object name from message location. Returns null if location doesn't contains Package object.

Returns:: String name

getProblemSeverity

public java.lang.String getProblemSeverity()

Returns the text description of the severity of the problem that caused this message.

getProjectName

public java.lang.String getProjectName()