kieker.checkstyle
Class AnalysisComponentConstructorCheck

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended by com.puppycrawl.tools.checkstyle.api.Check
              extended by kieker.checkstyle.AnalysisComponentConstructorCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class AnalysisComponentConstructorCheck
extends com.puppycrawl.tools.checkstyle.api.Check

This is an additional checkstyle check which makes sure that all analysis components supply the default constructor (using a Configuration and an IProjectContext object) we need for the framework.

Keep in mind that the check is not perfect, as checkstyle has some limitations. The main drawback is that we cannot check types. We can therefore not recognize whether a class inherits directly or indirectly from AbstractAnalysisComponent. Instead we use the annotations Plugin and Repository to check whether a class is an analysis component or not. This can lead to false positives. Furthermore we cannot check the types of the parameters for the constructors either. We use the names of the types to check this. This can lead to false positives as well.

The check provides a property to ignore abstract classes.

Since:
1.7

Constructor Summary
AnalysisComponentConstructorCheck()
          Creates a new instance of this class.
 
Method Summary
 int[] getDefaultTokens()
           
 void setIgnoreAbstractClasses(boolean ignoreAbstractClasses)
          Setter for the property ignoreAbstractClasses.
 void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
           
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnalysisComponentConstructorCheck

public AnalysisComponentConstructorCheck()
Creates a new instance of this class.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
Specified by:
getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.Check

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
Overrides:
visitToken in class com.puppycrawl.tools.checkstyle.api.Check

setIgnoreAbstractClasses

public void setIgnoreAbstractClasses(boolean ignoreAbstractClasses)
Setter for the property ignoreAbstractClasses.

Parameters:
ignoreAbstractClasses - The new value of the property.