|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
public class HeaderCheck
Checks the header of the source against a fixed header file.
Constructor Summary | |
---|---|
HeaderCheck()
|
Method Summary | |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree. |
protected com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo |
createHeaderInfo()
Abstract factory method to create an unconfigured header info bean. |
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. |
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck |
---|
finishLocalSetup, getDefaultTokens, getHeaderInfo, getHeaderLines, setHeader, setHeaderFile |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
---|
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
---|
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, 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 |
Constructor Detail |
---|
public HeaderCheck()
Method Detail |
---|
protected boolean isMatch(int aLineNumber)
aLineNumber
- the linenumber to check against the header
public void setIgnoreLines(int[] aList)
aList
- comma separated list of line numbers to ignore in header.public void beginTree(DetailAST aRootAST)
beginTree
in class Check
aRootAST
- the root of the treeprotected com.puppycrawl.tools.checkstyle.checks.header.HeaderInfo createHeaderInfo()
createHeaderInfo
in class AbstractHeaderCheck
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |