edu.cmu.cs.crystal.internal
Class StandardAnalysisReporter

java.lang.Object
  extended by edu.cmu.cs.crystal.internal.StandardAnalysisReporter
All Implemented Interfaces:
IAnalysisReporter

public class StandardAnalysisReporter
extends Object
implements IAnalysisReporter

An analysis reporter to be used when running analyses through Eclipse. All methods will print/output to the standard locations in Eclipse.

Author:
Nels E. Beckman

Nested Class Summary
 
Nested classes/interfaces inherited from interface edu.cmu.cs.crystal.IAnalysisReporter
IAnalysisReporter.SEVERITY
 
Field Summary
static String REGRESSION_LOGGER
           
 
Constructor Summary
StandardAnalysisReporter()
           
 
Method Summary
 void clearMarkersForCompUnit(ITypeRoot compUnit)
          For the given compilation unit, clear all the user problems which were reported, if necessary.
 PrintWriter debugOut()
           
 void reportUserProblem(String problemDescription, ASTNode node, String analysisName)
          Indicate that the running of this analysis on this compilation unit has created a problem.
 void reportUserProblem(String problemDescription, ASTNode node, String analysisName, IAnalysisReporter.SEVERITY severity)
          Indicate that the running of this analysis on this compilation unit has created a problem.
 PrintWriter userOut()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REGRESSION_LOGGER

public static final String REGRESSION_LOGGER
See Also:
Constant Field Values
Constructor Detail

StandardAnalysisReporter

public StandardAnalysisReporter()
Method Detail

clearMarkersForCompUnit

public void clearMarkersForCompUnit(ITypeRoot compUnit)
Description copied from interface: IAnalysisReporter
For the given compilation unit, clear all the user problems which were reported, if necessary. Implementers are free to implement this method as necessary, including by doing nothing at all.

Specified by:
clearMarkersForCompUnit in interface IAnalysisReporter

debugOut

public PrintWriter debugOut()
Specified by:
debugOut in interface IAnalysisReporter

userOut

public PrintWriter userOut()
Specified by:
userOut in interface IAnalysisReporter

reportUserProblem

public void reportUserProblem(String problemDescription,
                              ASTNode node,
                              String analysisName)
Description copied from interface: IAnalysisReporter
Indicate that the running of this analysis on this compilation unit has created a problem. By default, this will have a severity level of "INFO".

Specified by:
reportUserProblem in interface IAnalysisReporter
Parameters:
problemDescription - A textual description of the problem.
node - The AST node where the problem was encountered.
analysisName - The name of the Crystal analysis that is reporting the problem.

reportUserProblem

public void reportUserProblem(String problemDescription,
                              ASTNode node,
                              String analysisName,
                              IAnalysisReporter.SEVERITY severity)
Description copied from interface: IAnalysisReporter
Indicate that the running of this analysis on this compilation unit has created a problem.

Specified by:
reportUserProblem in interface IAnalysisReporter
Parameters:
problemDescription - A textual description of the problem.
node - The AST node where the problem was encountered.
analysisName - The name of the Crystal analysis that is reporting the problem.
severity - The severity level of this problem