com.puppycrawl.tools.checkstyle.checks.header

Class HeaderCheck

public class HeaderCheck extends AbstractHeaderCheck

Checks the header of the source against a fixed header file.

Author: Lars Kühne

Method Summary
voidbeginTree(DetailAST aRootAST)
{@inheritDoc}
protected booleanisMatch(int aLineNumber)
Checks if a code line matches the required header line.
voidsetIgnoreLines(int[] aList)
Set the lines numbers to ignore in the header check.

Method Detail

beginTree

public void beginTree(DetailAST aRootAST)
{@inheritDoc}

isMatch

protected boolean isMatch(int aLineNumber)
Checks if a code line matches the required header line.

Parameters: aLineNumber the linenumber to check against the header

Returns: true if and only if the line matches the required header line

setIgnoreLines

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

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