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 the files have a specific line ending (LF or CRLF).

Files containing mixed line endings may produce multiple violations, one for each line that does not match the configured line ending.

Notes: This check treats each line independently and reports violations per line.

Since:

12.4.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 separator 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_CRLF	A key is pointing to the warning message text in "message.properties" file.
static final String	MSG_KEY_WRONG_ENDING_LF	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	checkCrlfLineEndings(byte... content)	Checks that the file content uses CRLF line endings.
private void	checkLfLineEndings(byte... content)	Checks that the file content uses LF line endings.
protected void	processFiltered(File file, FileText fileText)	Called to process a file that matches the specified file extensions.
private void	readAndCheckFile(File file)	Reads the given file and checks its line endings against the configured line ending option.
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_LF

public static final String MSG_KEY_WRONG_ENDING_LF

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

See Also:

• Constant Field Values

MSG_KEY_WRONG_ENDING_CRLF

public static final String MSG_KEY_WRONG_ENDING_CRLF

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

See Also:

• Constant Field Values

lineEnding

private LineEndingOption lineEnding

Default line separator LF.

Constructor Details

LineEndingCheck

public LineEndingCheck()

Method Details

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.

setLineEnding

public void setLineEnding(String ending)

Setter to set lineEnding.

Parameters:

ending - string of value LF or CRLF

Since:

12.3.0

readAndCheckFile

private void readAndCheckFile(File file)
                       throws IOException

Reads the given file and checks its line endings against the configured line ending option.

Parameters:

file - the file to be processed

Throws:

IOException - if an I/O error occurs while reading the file

checkLfLineEndings

private void checkLfLineEndings(byte... content)

Checks that the file content uses LF line endings.

Parameters:

content - the file content as a byte array

checkCrlfLineEndings

private void checkCrlfLineEndings(byte... content)

Checks that the file content uses CRLF line endings.

Parameters:

content - the file content as a byte array