Class HeaderCheck

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

All Implemented Interfaces:

Configurable, Contextualizable, ExternalResourceHolder, FileSetCheck

public class HeaderCheck
extends AbstractHeaderCheck

Checks that a source file begins with a specified header. Property headerFile specifies a file that contains the required header. Alternatively, the header specification can be set directly in the header property without the need for an external file.

Notes: 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.

Since:

3.2

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private BitSet	ignoreLines	Specifies the line numbers to ignore when matching lines in a content of headerFile.
static final String	MSG_MISMATCH	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_MISSING	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
HeaderCheck()

Method Summary

Modifier and Type	Method	Description
private boolean	isIgnoreLine(int lineNo)	Returns true if lineNo is header lines or false.
private boolean	isMatch(int lineNumber, 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(File file, FileText fileText)	Called to process a file that matches the specified file extensions.
void	setIgnoreLines(int... lines)	Setter to specifies the line numbers to ignore when matching lines in a content of headerFile.

Methods inherited from class AbstractHeaderCheck

finishLocalSetup, getExternalResourceLocations, getHeaderLines, setCharset, setHeader, setHeaderFile

Methods inherited from class AbstractFileSetCheck

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

Methods inherited from class AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Configurable

configure

Methods inherited from interface Contextualizable

contextualize

Field Details

MSG_MISSING

public static final 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 String MSG_MISMATCH

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

ignoreLines

private BitSet ignoreLines

Specifies the line numbers to ignore when matching lines in a content of headerFile.

Constructor Details

HeaderCheck

public HeaderCheck()

Method Details

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

private boolean isMatch(int lineNumber,
 String line)

Checks if a code line matches the required header line.

Parameters:

lineNumber - the line number to check against the header

line - the line contents

Returns:

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

setIgnoreLines

public void setIgnoreLines(int... lines)

Setter to specifies the line numbers to ignore when matching lines in a content of headerFile.

Parameters:

lines - line numbers to ignore in header.

Since:

3.2

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.

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