Class RegexpHeaderCheck
- 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.RegexpHeaderCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,ExternalResourceHolder
,FileSetCheck
public class RegexpHeaderCheck extends AbstractHeaderCheck
Checks the header of the source against a header file that contains aregular expression
for each line of the source header. 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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description static String
MSG_HEADER_MISMATCH
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_HEADER_MISSING
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description RegexpHeaderCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
postProcessHeaderLines()
Hook method for post processing header lines.protected void
processFiltered(File file, FileText fileText)
Called to process a file that matches the specified file extensions.void
setHeader(String header)
Validates theheader
by compiling it withPattern.compile(String)
and throwsIllegalArgumentException
ifheader
isn't a valid pattern.void
setMultiLines(int... list)
Set the lines numbers to repeat in the header check.-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
finishLocalSetup, getExternalResourceLocations, getHeaderLines, setCharset, setHeaderFile
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addMessages, beginProcessing, destroy, finishProcessing, fireErrors, getFileExtensions, getMessageDispatcher, init, log, log, process, setFileExtensions, setMessageDispatcher
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, 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_HEADER_MISSING
public static final String MSG_HEADER_MISSING
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_HEADER_MISMATCH
public static final String MSG_HEADER_MISMATCH
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
setMultiLines
public void setMultiLines(int... list)
Set the lines numbers to repeat in the header check.- Parameters:
list
- comma separated list of line numbers to repeat in header.
-
processFiltered
protected void processFiltered(File file, FileText fileText)
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 processedfileText
- 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
-
setHeader
public void setHeader(String header)
Validates theheader
by compiling it withPattern.compile(String)
and throwsIllegalArgumentException
ifheader
isn't a valid pattern.- Overrides:
setHeader
in classAbstractHeaderCheck
- Parameters:
header
- the header value to validate and set (in that order)
-
-