com.puppycrawl.tools.checkstyle.checks.header
Class HeaderCheck
- Configurable, Contextualizable
Checks the header of the source against a fixed header file.
void | beginTree(DetailAST aRootAST) -
|
protected com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo | createHeaderInfo() -
|
protected boolean | isMatch(int aLineNumber) - Checks if a code line matches the required header line.
|
void | setIgnoreLines(int[] aList) - Set the lines numbers to ignore in the header check.
|
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
getId , getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setId , setSeverity |
isMatch
protected boolean isMatch(int aLineNumber)
Checks if a code line matches the required header line.
aLineNumber
- the linenumber to check against the header
- 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.
aList
- comma separated list of line numbers to ignore in header.