com.puppycrawl.tools.checkstyle.checks.header

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, FileSetCheck

public class RegexpHeaderCheck
extends AbstractHeaderCheck

Checks the header of the source against a header file that contains a regular 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.

Author:

Lars Kühne, o_sukhodolsky

Constructor Summary

Constructors

Constructor and Description
RegexpHeaderCheck()

Method Summary

Modifier and Type	Method and Description
protected void	postProcessHeaderLines() Hook method for post processing header lines.
protected void	processFiltered(File file, List<String> lines) Called to process a file that matches the specified file extensions.
void	setHeader(String header) Validates the header by compiling it with Pattern.compile(String) and throws PatternSyntaxException if header 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, getHeaderLines, setCharset, 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

Constructor Detail

RegexpHeaderCheck

public RegexpHeaderCheck()

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,
                               List<String> lines)

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

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

Overrides:

postProcessHeaderLines in class AbstractHeaderCheck

setHeader

public void setHeader(String header)

Validates the header by compiling it with Pattern.compile(String) and throws PatternSyntaxException if header isn't a valid pattern.

Overrides:

setHeader in class AbstractHeaderCheck

Parameters:

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