public class FinalClassCheck extends AbstractCheck
Checks that a class which has only private constructors
is declared as final. Doesn't check for classes nested in interfaces
or annotations, as they are always final there.
To configure the check:
<module name="FinalClass"/>
Example:
final class MyClass { // OK
private MyClass() { }
}
class MyClass { // violation, class should be declared final
private MyClass() { }
}
class MyClass { // OK, since it has a public constructor
int field1;
String field2;
private MyClass(int value) {
this.field1 = value;
this.field2 = " ";
}
public MyClass(String value) {
this.field2 = value;
this.field1 = 0;
}
}
interface CheckInterface
{
class MyClass { // OK, nested class in interface is always final
private MyClass() {}
}
}
public @interface Test {
public boolean enabled()
default true;
class MyClass { // OK, class nested in an annotation is always final
private MyClass() { }
}
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
final.class
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
FinalClassCheck() |
| Modifier and Type | Method and Description |
|---|---|
void |
beginTree(DetailAST rootAST)
Called before the starting to process a tree.
|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
leaveToken(DetailAST ast)
Called after all the child nodes have been process.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final java.lang.String MSG_KEY
public FinalClassCheck()
public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void beginTree(DetailAST rootAST)
AbstractCheckbeginTree in class AbstractCheckrootAST - the root of the treepublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processpublic void leaveToken(DetailAST ast)
AbstractCheckleaveToken in class AbstractCheckast - the token leavingCopyright © 2001-2020. All Rights Reserved.