com.togethersoft.sca.core.plugin.report
Class ReportMessage

java.lang.Object
  |
  +--com.togethersoft.sca.core.plugin.report.ReportMessage

All Implemented Interfaces:

IReportMessage

public class ReportMessage

extends java.lang.Object

implements IReportMessage

Author:

Sergey Gorelkin

Constructor Summary

ReportMessage(java.lang.String projectName, IAuditMessage msg)

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportMessage

public ReportMessage(java.lang.String projectName,
                     IAuditMessage msg)

Method Detail

getAnalyzer

public IAnalyzerDescriptor getAnalyzer()

Description copied from interface: IReportMessage

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

Specified by:

getAnalyzer in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

the descriptor of the code analyzer that produced this message.

getAstObjectKind

public int getAstObjectKind()

Description copied from interface: IReportMessage

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

Specified by:

getAstObjectKind in interface IReportMessage

getCompilationUnitName

public java.lang.String getCompilationUnitName()

Description copied from interface: IReportMessage

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

Specified by:

getCompilationUnitName in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

String name

getEndColumn

public int getEndColumn()

Description copied from interface: IReportMessage

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.

Specified by:

getEndColumn in interface IReportMessage

getEndLine

public int getEndLine()

Description copied from interface: IReportMessage

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.

Specified by:

getEndLine in interface IReportMessage

getFileName

public java.lang.String getFileName()

Description copied from interface: IReportMessage

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.

Specified by:

getFileName in interface IReportMessage

getMessage

public java.lang.String getMessage()

Description copied from interface: IReportMessage

Returns the unformatted text of this message.

Specified by:

getMessage in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

the text of this message.

getMethodName

public java.lang.String getMethodName()

Description copied from interface: IReportMessage

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

Specified by:

getMethodName in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

String name

getPackageName

public java.lang.String getPackageName()

Description copied from interface: IReportMessage

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

Specified by:

getPackageName in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

String name

getProblemSeverity

public java.lang.String getProblemSeverity()

Description copied from interface: IReportMessage

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

Specified by:

getProblemSeverity in interface IReportMessage

getProjectName

public java.lang.String getProjectName()

Description copied from interface: IReportMessage

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

Specified by:

getProjectName in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

String name

getStartColumn

public int getStartColumn()

Description copied from interface: IReportMessage

Returns the start 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.

Specified by:

getStartColumn in interface IReportMessage

getStartLine

public int getStartLine()

Description copied from interface: IReportMessage

Returns the start 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.

Specified by:

getStartLine in interface IReportMessage

getSubMessages

public IReportMessage[] getSubMessages()

Description copied from interface: IReportMessage

Method getSubMessages.

Specified by:

getSubMessages in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

AuditMessage[] array of sub messages

getTypeName

public java.lang.String getTypeName()

Description copied from interface: IReportMessage

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

Specified by:

getTypeName in interface IReportMessage

Following copied from interface: com.togethersoft.sca.core.plugin.report.IReportMessage

Returns:

String name