com.thomasjensen.checkstyle.addons.util

Class CheckstyleApiFixer

java.lang.Object

com.thomasjensen.checkstyle.addons.util.CheckstyleApiFixer

public class CheckstyleApiFixer
extends java.lang.Object

The public API of the Checkstyle tool changes frequently, and many releases of Checkstyle are incompatible with their predecessors. This class uses reflection in order to allow the Checkstyle Addons code to work with all dependency configurations. It simply provides a stable interface with workarounds for all supported Checkstyle versions.

Constructor Summary

Constructors

Constructor and Description
CheckstyleApiFixer(com.puppycrawl.tools.checkstyle.api.AbstractCheck pCheck) Constructor.
CheckstyleApiFixer(com.puppycrawl.tools.checkstyle.api.AbstractCheck pCheck, java.lang.String pCurrentFileNameMockFile) Constructor.

Method Summary

Modifier and Type	Method and Description
java.io.File	getCurrentFileName() Wrapper for FileContents.getFileName() (Checkstyle issue #1205).
java.lang.String	getTokenName(int pTokenId) Returns the name of a token for a given ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckstyleApiFixer

public CheckstyleApiFixer(@Nonnull
                          com.puppycrawl.tools.checkstyle.api.AbstractCheck pCheck)

Constructor.

Parameters:

pCheck - the check for which this instance of the API fixer shall run

CheckstyleApiFixer

public CheckstyleApiFixer(@Nonnull
                          com.puppycrawl.tools.checkstyle.api.AbstractCheck pCheck,
                          @Nullable
                          java.lang.String pCurrentFileNameMockFile)

Constructor.

Parameters:

pCheck - the check for which this instance of the API fixer shall run

pCurrentFileNameMockFile - file to use as result of getCurrentFileName() in unit tests

Method Detail

getCurrentFileName

@CheckForNull
public java.io.File getCurrentFileName()

Wrapper for FileContents.getFileName() (Checkstyle issue #1205).

Returns:

the currently analyzed file as returned by Checkstyle

Throws:

java.lang.UnsupportedOperationException - no known variant of FileContents.getFileName() could be found

getTokenName

@Nonnull
public java.lang.String getTokenName(int pTokenId)

Returns the name of a token for a given ID.

Parameters:

pTokenId - the ID of the token name to get

Returns:

a token name as returned by Checkstyle

Throws:

java.lang.UnsupportedOperationException - no known variant of getTokenName() could be found