kieker.checkstyle
Class MonitoringRecordFactoryConventionCheck

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.MonitoringRecordFactoryConventionCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

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

This class extends checkstyle with a new check which makes sure that classes, which implement the IMonitoringRecord.Factory interface, supply the necessary static field (for the types) and the constructor (working with an array of Object) for the framework.

Keep in mind that the check is not perfect, as checkstyle has some limitations. There can therefore be some false positives.

The check provides a property to ignore abstract classes.

Since:
1.7

Constructor Summary
MonitoringRecordFactoryConventionCheck()
          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

MonitoringRecordFactoryConventionCheck

public MonitoringRecordFactoryConventionCheck()
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.