Class HeaderCheck
- java.lang.Object
-
- com.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
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,ExternalResourceHolder
,FileSetCheck
public class HeaderCheck extends AbstractHeaderCheck
Checks the header of the source against a fixed header file. In default configuration,if header is not specified, the default value of header is set to null and the check does not rise any violations.
-
-
Field Summary
Fields Modifier and Type Field Description private static int[]
EMPTY_INT_ARRAY
Empty array to avoid instantiations.private int[]
ignoreLines
The header lines to ignore in the check, sorted.static java.lang.String
MSG_MISMATCH
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_MISSING
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description HeaderCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private boolean
isIgnoreLine(int lineNo)
Returns true if lineNo is header lines or false.protected boolean
isMatch(int lineNumber, java.lang.String line)
Checks if a code line matches the required header line.protected void
postProcessHeaderLines()
Hook method for post processing header lines.protected void
processFiltered(java.io.File file, java.util.List<java.lang.String> lines)
Called to process a file that matches the specified file extensions.void
setIgnoreLines(int... list)
Set the lines numbers to ignore in the header check.-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
finishLocalSetup, getExternalResourceLocations, getHeaderLines, setCharset, setHeader, setHeaderFile
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
beginProcessing, destroy, finishProcessing, fireErrors, getFileExtensions, 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
-
-
-
-
Field Detail
-
MSG_MISSING
public static final java.lang.String MSG_MISSING
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_MISMATCH
public static final java.lang.String MSG_MISMATCH
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
EMPTY_INT_ARRAY
private static final int[] EMPTY_INT_ARRAY
Empty array to avoid instantiations.
-
ignoreLines
private int[] ignoreLines
The header lines to ignore in the check, sorted.
-
-
Method Detail
-
isIgnoreLine
private boolean isIgnoreLine(int lineNo)
Returns true if lineNo is header lines or false.- Parameters:
lineNo
- a line number- Returns:
- if
lineNo
is one of the ignored header lines.
-
isMatch
protected boolean isMatch(int lineNumber, java.lang.String line)
Checks if a code line matches the required header line.- Parameters:
lineNumber
- the line number to check against the headerline
- the line contents- Returns:
- true if and only if the line matches the required header line
-
setIgnoreLines
public void setIgnoreLines(int... list)
Set the lines numbers to ignore in the header check.- Parameters:
list
- comma separated list of line numbers to ignore in header.
-
processFiltered
protected void processFiltered(java.io.File file, java.util.List<java.lang.String> lines)
Description copied from class:AbstractFileSetCheck
Called to process a file that matches the specified file extensions.- Specified by:
processFiltered
in classAbstractFileSetCheck
- Parameters:
file
- the file to be processedlines
- 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.- Specified by:
postProcessHeaderLines
in classAbstractHeaderCheck
-
-