public final class AbstractClassNameCheck extends Check
Ensures that the names of abstract classes conforming to some
regular expression and check that abstract
modifier exists.
Rationale: Abstract classes are convenience base class implementations of interfaces, not types as such. As such they should be named to indicate this. Also if names of classes starts with 'Abstract' it's very convenient that they will have abstract modifier.
Modifier and Type | Field and Description |
---|---|
static String |
MSG_ILLEGAL_ABSTRACT_CLASS_NAME
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_NO_ABSTRACT_CLASS_MODIFIER
A key is pointing to the warning message text in "messages.properties"
file.
|
Constructor and Description |
---|
AbstractClassNameCheck() |
Modifier and Type | Method and Description |
---|---|
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 |
setFormat(String format)
Set the format to the specified regular expression.
|
void |
setIgnoreModifier(boolean value)
Whether to ignore checking for the
abstract modifier. |
void |
setIgnoreName(boolean value)
Whether to ignore checking the name.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String MSG_ILLEGAL_ABSTRACT_CLASS_NAME
public static final String MSG_NO_ABSTRACT_CLASS_MODIFIER
public void setIgnoreModifier(boolean value)
abstract
modifier.value
- new valuepublic void setIgnoreName(boolean value)
value
- new value.public void setFormat(String format)
format
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse formatpublic int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processCopyright © 2001–2016. All rights reserved.