public class FileTabCharacterCheck extends AbstractFileSetCheck
Checks that there are no tab characters ('\t') in the source code.
Rationale:
eachLine - Control whether to report on each line containing a tab,
or just the first instance.
Type is boolean.
Default value is false.
fileExtensions - Specify file type extension of files to process.
Type is java.lang.String[].
Default value is "".
To configure the check to report only the first instance in each file:
<module name="FileTabCharacter"/>
Example - Test.java:
public class Test {
int a; // violation, indented using tab
public void foo (int arg) { // OK, indented using tab, only first occurrence in file reported
a = arg; // OK, indented using spaces
} // OK, indented using spaces
}
To configure the check to report each instance in each file:
<module name="FileTabCharacter"> <property name="eachLine" value="true"/> </module>
Example - Test.java:
public class Test {
int a; // violation, indented using tab
public void foo (int arg) { // violation, indented using tab
a = arg; // OK, indented using spaces
} // OK, indented using spaces
}
To configure the check to report instances on only certain file types:
<module name="FileTabCharacter"> <property name="fileExtensions" value="java, xml"/> </module>
Example - Test.java:
public class Test {
int a; // violation, indented using tab
public void foo (int arg) { // OK, indented using tab, only first occurrence in file reported
a = arg; // OK, indented using spaces
} // OK, indented using spaces
}
Example - Test.xml:
<?xml version="1.0" encoding="UTF-8" ?> <UserAccount> <FirstName>John</FirstName> <!-- violation, indented using tab --> <LastName>Doe</LastName> <!-- only first occurrence in file reported --> </UserAccount>
Example - Test.html:
<head> <title>Page Title</title> <!-- no check performed, html file extension --> </head> <!-- not specified in check config --> <body> <p>This is a simple html document.</p> </body>
Parent is com.puppycrawl.tools.checkstyle.Checker
Violation Message Keys:
containsTab
file.containsTab
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
private boolean |
eachLine
Control whether to report on each line containing a tab, or just the first instance.
|
static java.lang.String |
MSG_CONTAINS_TAB
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_FILE_CONTAINS_TAB
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
FileTabCharacterCheck() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
processFiltered(java.io.File file,
FileText fileText)
Called to process a file that matches the specified file extensions.
|
void |
setEachLine(boolean eachLine)
Setter to control whether to report on each line containing a tab, or just the first
instance.
|
addViolations, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getTabWidth, getViolations, init, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidthfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitconfigurecontextualizepublic static final java.lang.String MSG_CONTAINS_TAB
public static final java.lang.String MSG_FILE_CONTAINS_TAB
private boolean eachLine
public FileTabCharacterCheck()
protected void processFiltered(java.io.File file, FileText fileText)
AbstractFileSetCheckprocessFiltered in class AbstractFileSetCheckfile - the file to be processedfileText - the contents of the file.public void setEachLine(boolean eachLine)
eachLine - Whether report on each line containing a tab.Copyright © 2001-2022. All Rights Reserved.