|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
public final class AbstractClassNameCheck
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.
Constructor Summary | |
---|---|
AbstractClassNameCheck()
Creates new instance of the check. |
Method Summary | |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
int[] |
getRequiredTokens()
The tokens that this check must be registered for. |
void |
setIgnoreModifier(boolean aValue)
Whether to ignore checking for the abstract modifier. |
void |
setIgnoreName(boolean aValue)
Whether to ignore checking the name. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck |
---|
getFormat, getRegexp, setCompileFlags, setFormat |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
---|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
---|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
---|
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractClassNameCheck()
Method Detail |
---|
public void setIgnoreModifier(boolean aValue)
abstract
modifier.
aValue
- new valuepublic void setIgnoreName(boolean aValue)
aValue
- new value.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to process
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |