Class FileTabCharacterCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable, FileSetCheck

    public class FileTabCharacterCheck
    extends AbstractFileSetCheck

    Checks that there are no tab characters ('\t') in the source code.

    Rationale:

    • Developers should not need to configure the tab width of their text editors in order to be able to read source code.
    • From the Apache jakarta coding standards: In a distributed development environment, when the commit messages get sent to a mailing list, they are almost impossible to read if you use tabs.
    • Property eachLine - Control whether to report on each line containing a tab, or just the first instance. Type is boolean. Default value is false.
    • Property fileExtensions - Specify the file extensions of the files to process. Type is java.lang.String[]. Default value is "".

    Parent is com.puppycrawl.tools.checkstyle.Checker

    Violation Message Keys:

    • containsTab
    • file.containsTab
    Since:
    5.0
    • Method Detail

      • setEachLine

        public void setEachLine​(boolean eachLine)
        Setter to control whether to report on each line containing a tab, or just the first instance.
        Parameters:
        eachLine - Whether report on each line containing a tab.
        Since:
        5.0