Package com.puppycrawl.tools.checkstyle.checks

Class LineEndingCheck

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

All Implemented Interfaces:

Configurable, Contextualizable, FileSetCheck

public class LineEndingCheck
extends AbstractFileSetCheck

Checks whether file uses a specific line-ending sequence (LF, CRLF, or CR).

A violation is reported for each line whose actual line ending does not match the configured one.

Notes: Files containing mixed line endings may produce multiple violations, one for each non-matching line.

Since:

13.3.0

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 LineEndingOption	lineEnding	Default line ending LF.
static final String	MSG_KEY_UNABLE_OPEN	A key is pointing to the warning message text in "message.properties" file.
static final String	MSG_KEY_WRONG_ENDING	A key is pointing to the warning message text in "message.properties" file.

Constructor Summary

Constructors

Constructor	Description
LineEndingCheck()

Method Summary

Modifier and Type	Method	Description
private void	checkLineEndings(LineEndingOption expected, byte... content)	Checks that the file content uses the configured line ending and logs a violation for each line that does not match.
private void	logIncorrectLineEnding(int line, LineEndingOption wrongLineEnding)	Logs an incorrect line ending detected at the given line.
protected void	processFiltered(File file, FileText fileText)	Called to process a file that matches the specified file extensions.
void	setLineEnding(String ending)	Setter to set lineEnding.

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

finishLocalSetup, 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_KEY_UNABLE_OPEN

public static final String MSG_KEY_UNABLE_OPEN

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

See Also:

• Constant Field Values

MSG_KEY_WRONG_ENDING

public static final String MSG_KEY_WRONG_ENDING

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

See Also:

• Constant Field Values

lineEnding

private LineEndingOption lineEnding

Default line ending LF.

Constructor Details

LineEndingCheck

public LineEndingCheck()

Method Details

setLineEnding

public void setLineEnding(String ending)

Setter to set lineEnding.

Parameters:

ending - string of value LF or CRLF

Since:

13.3.0

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.

checkLineEndings

private void checkLineEndings(LineEndingOption expected,
 byte... content)

Checks that the file content uses the configured line ending and logs a violation for each line that does not match.

Parameters:

expected - the expected line ending

content - the file content as bytes

logIncorrectLineEnding

private void logIncorrectLineEnding(int line,
 LineEndingOption wrongLineEnding)

Logs an incorrect line ending detected at the given line.

Parameters:

line - the line number where the issue was found

wrongLineEnding - the detected incorrect line ending