Package ch.usi.si.codelounge.jsicko.plugin.diagnostics

Class JSickoDiagnostic

java.lang.Object

ch.usi.si.codelounge.jsicko.plugin.diagnostics.JSickoDiagnostic

Direct Known Subclasses:

JSickoDiagnostic.JSickoError, JSickoDiagnostic.JSickoNote, JSickoDiagnostic.JSickoWarning

public abstract class JSickoDiagnostic
extends Object

Holder for JSicko Diagnostic classes and utility methods. A diagnostic is a note, warning, or error emitted by JSicko during instrumentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JSickoDiagnostic.JSickoError	A JSicko error.
static class	JSickoDiagnostic.JSickoNote	A JSicko note.
static class	JSickoDiagnostic.JSickoWarning	A JSicko warning.

Constructor Summary

Constructors

Constructor	Description
JSickoDiagnostic()

Method Summary

Modifier and Type	Method	Description
static JSickoDiagnostic.JSickoError	ClauseIsNotBoolean(ConditionClause clause, com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbolMarkedAsClause)
static JSickoDiagnostic.JSickoNote	ConditionCheckNote(com.sun.tools.javac.code.Symbol.MethodSymbol sym, ContractConditionEnum conditionType, com.sun.tools.javac.util.List<com.sun.tools.javac.util.List<ConditionClause>> groupedClauses)
static JSickoDiagnostic.JSickoNote	ContractInterfacesNote(com.sun.tools.javac.code.Symbol.ClassSymbol sym, com.sun.tools.javac.util.List<com.sun.tools.javac.code.Type> contracts)
static JSickoDiagnostic.JSickoError	IncompatibleClause(ConditionClause clause, boolean isMethodStatic, com.sun.tools.javac.util.Name methodName)
static JSickoDiagnostic.JSickoNote	InstrumentedClassNote(com.sun.tools.javac.tree.JCTree.JCClassDecl jcClassDecl)
static JSickoDiagnostic.JSickoNote	InstrumentedMethodNote(com.sun.tools.javac.tree.JCTree.JCMethodDecl jcMethodDecl)
static JSickoDiagnostic.JSickoError	InvariantHasNonZeroArity(com.sun.tools.javac.tree.JCTree.JCMethodDecl methodDeclMarkedAsInvariant)
static JSickoDiagnostic.JSickoError	InvariantIsNotBoolean(com.sun.tools.javac.tree.JCTree.JCMethodDecl methodDeclMarkedAsInvariant)
static JSickoDiagnostic.JSickoError	InvariantIsStatic(com.sun.tools.javac.tree.JCTree.JCMethodDecl methodDeclMarkedAsInvariant)
static JSickoDiagnostic.JSickoError	MissingClause(ConditionClause clause)	Generates a JSicko missing clause error.
static JSickoDiagnostic.JSickoError	MissingParamName(com.sun.tools.javac.util.Name paramName, ConditionClause clause)
static JSickoDiagnostic.JSickoNote	OverriddenOldMethodNote(com.sun.tools.javac.tree.JCTree.JCMethodDecl overriddenOldMethod)
static JSickoDiagnostic.JSickoError	RaisesOnPrecondition(ConditionClause clause)
static JSickoDiagnostic.JSickoError	ReturnsOnPrecondition(ConditionClause clause)
static JSickoDiagnostic.JSickoError	ReturnsOnVoidMethod(ConditionClause clause)
static JSickoDiagnostic.JSickoError	WrongParamType(com.sun.tools.javac.util.Name paramName, com.sun.tools.javac.code.Type expectedType, com.sun.tools.javac.code.Type clauseType, ConditionClause clause)

Methods inherited from class java.lang.Object

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

Constructor Detail

JSickoDiagnostic

public JSickoDiagnostic()

Method Detail

MissingClause

public static JSickoDiagnostic.JSickoError MissingClause(ConditionClause clause)

Generates a JSicko missing clause error. A missing clause error represent the usage of a clause in a precondition or postcondition that has no corresponding method.

Parameters:

clause - the missing clause.

Returns:

a JSickoError representing the diagnostic to be emitted.

MissingParamName

public static JSickoDiagnostic.JSickoError MissingParamName(com.sun.tools.javac.util.Name paramName,
                                                            ConditionClause clause)

WrongParamType

public static JSickoDiagnostic.JSickoError WrongParamType(com.sun.tools.javac.util.Name paramName,
                                                          com.sun.tools.javac.code.Type expectedType,
                                                          com.sun.tools.javac.code.Type clauseType,
                                                          ConditionClause clause)

ReturnsOnVoidMethod

public static JSickoDiagnostic.JSickoError ReturnsOnVoidMethod(ConditionClause clause)

ReturnsOnPrecondition

public static JSickoDiagnostic.JSickoError ReturnsOnPrecondition(ConditionClause clause)

RaisesOnPrecondition

public static JSickoDiagnostic.JSickoError RaisesOnPrecondition(ConditionClause clause)

InvariantHasNonZeroArity

public static JSickoDiagnostic.JSickoError InvariantHasNonZeroArity(com.sun.tools.javac.tree.JCTree.JCMethodDecl methodDeclMarkedAsInvariant)

InvariantIsStatic

public static JSickoDiagnostic.JSickoError InvariantIsStatic(com.sun.tools.javac.tree.JCTree.JCMethodDecl methodDeclMarkedAsInvariant)

InvariantIsNotBoolean

public static JSickoDiagnostic.JSickoError InvariantIsNotBoolean(com.sun.tools.javac.tree.JCTree.JCMethodDecl methodDeclMarkedAsInvariant)

ClauseIsNotBoolean

public static JSickoDiagnostic.JSickoError ClauseIsNotBoolean(ConditionClause clause,
                                                              com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbolMarkedAsClause)

IncompatibleClause

public static JSickoDiagnostic.JSickoError IncompatibleClause(ConditionClause clause,
                                                              boolean isMethodStatic,
                                                              com.sun.tools.javac.util.Name methodName)

InstrumentedMethodNote

public static JSickoDiagnostic.JSickoNote InstrumentedMethodNote(com.sun.tools.javac.tree.JCTree.JCMethodDecl jcMethodDecl)

InstrumentedClassNote

public static JSickoDiagnostic.JSickoNote InstrumentedClassNote(com.sun.tools.javac.tree.JCTree.JCClassDecl jcClassDecl)

ContractInterfacesNote

public static JSickoDiagnostic.JSickoNote ContractInterfacesNote(com.sun.tools.javac.code.Symbol.ClassSymbol sym,
                                                                 com.sun.tools.javac.util.List<com.sun.tools.javac.code.Type> contracts)

ConditionCheckNote

public static JSickoDiagnostic.JSickoNote ConditionCheckNote(com.sun.tools.javac.code.Symbol.MethodSymbol sym,
                                                             ContractConditionEnum conditionType,
                                                             com.sun.tools.javac.util.List<com.sun.tools.javac.util.List<ConditionClause>> groupedClauses)

OverriddenOldMethodNote

public static JSickoDiagnostic.JSickoNote OverriddenOldMethodNote(com.sun.tools.javac.tree.JCTree.JCMethodDecl overriddenOldMethod)