com.puppycrawl.tools.checkstyle.checks.header
Class RegexpHeaderCheck

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.AbstractFileSetCheck
              extended by com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
                  extended by com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
All Implemented Interfaces:
Configurable, Contextualizable, FileSetCheck

public class RegexpHeaderCheck
extends AbstractHeaderCheck

Checks the header of the source against a header file that contains a regular expression for each line of the source header.

Author:
Lars Kühne, o_sukhodolsky

Constructor Summary
RegexpHeaderCheck()
           
 
Method Summary
protected  void postprocessHeaderLines()
          Hook method for post processing header lines.
protected  void processFiltered(File aFile, List<String> aLines)
          Called to process a file that matches the specified file extensions.
 void setMultiLines(int[] aList)
          Set the lines numbers to repeat in the header check.
 
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
finishLocalSetup, getHeaderLines, setCharset, setHeader, setHeaderFile
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
beginProcessing, destroy, finishProcessing, fireErrors, getMessageCollector, getMessageDispatcher, init, log, log, process, setFileExtensions, setMessageDispatcher
 
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, getConfiguration, setupChild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable
configure
 
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable
contextualize
 

Constructor Detail

RegexpHeaderCheck

public RegexpHeaderCheck()
Method Detail

setMultiLines

public void setMultiLines(int[] aList)
Set the lines numbers to repeat in the header check.

Parameters:
aList - comma separated list of line numbers to repeat in header.

processFiltered

protected void processFiltered(File aFile,
                               List<String> aLines)
Description copied from class: AbstractFileSetCheck
Called to process a file that matches the specified file extensions.

Specified by:
processFiltered in class AbstractFileSetCheck
Parameters:
aFile - the file to be processed
aLines - an immutable list of the contents of the file.

postprocessHeaderLines

protected void postprocessHeaderLines()
Description copied from class: AbstractHeaderCheck
Hook method for post processing header lines. This implementation does nothing.

Overrides:
postprocessHeaderLines in class AbstractHeaderCheck

Back to the Checkstyle Home Page