|
||||||||||
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.AbstractFileSetCheck
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 | |
---|---|
protected boolean |
isMatch(int aLineNumber,
java.lang.String aLine)
Checks if a code line matches the required header line. |
protected void |
processFiltered(java.io.File aFile,
java.util.List<java.lang.String> aLines)
Called to process a file that matches the specified file extensions. |
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, getHeaderLines, postprocessHeaderLines, 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 |
---|
public HeaderCheck()
Method Detail |
---|
protected boolean isMatch(int aLineNumber, java.lang.String aLine)
aLineNumber
- the line number to check against the headeraLine
- the line contents
public void setIgnoreLines(int[] aList)
aList
- comma separated list of line numbers to ignore in header.protected void processFiltered(java.io.File aFile, java.util.List<java.lang.String> aLines)
AbstractFileSetCheck
processFiltered
in class AbstractFileSetCheck
aFile
- the file to be processedaLines
- an immutable list of the contents of the file.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |