Package com.puppycrawl.tools.checkstyle.checks.header

Class RegexpHeaderCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

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 a source file against a header that contains a pattern for each line of the source header.

Since:

3.2

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	BLANK_LINE	Compiled regex pattern for a blank line.
private static final String	EMPTY_LINE_PATTERN	Regex pattern for a blank line.
private final List<Pattern>	headerRegexps	The compiled regular expressions.
static final String	MSG_HEADER_MISMATCH	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_HEADER_MISSING	A key is pointing to the warning message text in "messages.properties" file.
private BitSet	multiLines	Specify the line numbers to repeat (zero or more times).

Constructor Summary

Constructors

Constructor	Description
RegexpHeaderCheck()

Method Summary

Modifier and Type	Method	Description
private String	getHeaderLine(int headerLineNo)	Returns the line from the header.
private boolean	isMatch(String line, int headerLineNo)	Checks if a code line matches the required header line.
private boolean	isMultiLine(int lineNo)	Returns true if line is multiline header lines or false.
private void	logFirstSinglelineLine(int startHeaderLine, int headerSize)	Logs warning if any non-multiline lines left in header regexp.
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)	Setter to define the required header specified inline.
void	setMultiLines(int... list)	Setter to specify the line numbers to repeat (zero or more times).

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

addViolations, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getTabWidth, getViolations, init, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidth

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.AbstractAutomaticBean

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 Details

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

EMPTY_LINE_PATTERN

private static final String EMPTY_LINE_PATTERN

Regex pattern for a blank line.

See Also:

• Constant Field Values

BLANK_LINE

private static final Pattern BLANK_LINE

Compiled regex pattern for a blank line.

headerRegexps

private final List<Pattern> headerRegexps

The compiled regular expressions.

multiLines

private BitSet multiLines

Specify the line numbers to repeat (zero or more times).

Constructor Details

RegexpHeaderCheck

public RegexpHeaderCheck()

Method Details

setMultiLines

public void setMultiLines(int... list)

Setter to specify the line numbers to repeat (zero or more times).

Parameters:

list - line numbers to repeat in header.

Since:

3.4

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 class AbstractFileSetCheck

Parameters:

file - the file to be processed

fileText - the contents of the file.

getHeaderLine

private String getHeaderLine(int headerLineNo)

Returns the line from the header. Where the line is blank return the regexp pattern for a blank line.

Parameters:

headerLineNo - header line number to return

Returns:

the line from the header

logFirstSinglelineLine

private void logFirstSinglelineLine(int startHeaderLine,
 int headerSize)

Logs warning if any non-multiline lines left in header regexp.

Parameters:

startHeaderLine - header line number to start from

headerSize - whole header size

isMatch

private boolean isMatch(String line,
 int headerLineNo)

Checks if a code line matches the required header line.

Parameters:

line - the code line

headerLineNo - the header line number.

Returns:

true if and only if the line matches the required header line.

isMultiLine

private boolean isMultiLine(int lineNo)

Returns true if line is multiline header lines or false.

Parameters:

lineNo - a line number

Returns:

if lineNo is one of the repeat header lines.

postProcessHeaderLines

protected void postProcessHeaderLines()

Description copied from class: AbstractHeaderCheck

Hook method for post-processing header lines. This implementation does nothing.

Specified by:

postProcessHeaderLines in class AbstractHeaderCheck

setHeader

public void setHeader(String header)

Setter to define the required header specified inline. Individual header lines must be separated by the string "\n" (even on platforms with a different line separator). For header lines containing "\n\n" checkstyle will forcefully expect an empty line to exist. See examples below. Regular expressions must not span multiple lines.

Overrides:

setHeader in class AbstractHeaderCheck

Parameters:

header - the header value to validate and set (in that order)

Since:

5.0