|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.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.coding.IllegalTypeCheck
Checks that particular class are never used as types in variable declarations, return values or parameters. Includes a pattern check that by default disallows abstract classes.
Rationale: Helps reduce coupling on concrete classes. In addition abstract classes should be thought of a convenience base class implementations of interfaces and as such are not types themsleves.
Constructor Summary | |
IllegalTypeCheck()
Creates new instance of the check. |
Method Summary | |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens. |
java.lang.String[] |
getIgnoredMethodNames()
Set the list of ignored method names. |
java.lang.String[] |
getIllegalClassNames()
Set the list of illegal variable types. |
void |
setIgnoredMethodNames(java.lang.String[] aMethodNames)
Set the list of ignore method names. |
void |
setIllegalClassNames(java.lang.String[] aClassNames)
Set the list of illegal variable types. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck |
getFormat, getRegexp, setFormat |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, 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 IllegalTypeCheck()
Method Detail |
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to processpublic void setIllegalClassNames(java.lang.String[] aClassNames)
aClassNames
- array of illegal variable typespublic java.lang.String[] getIllegalClassNames()
public void setIgnoredMethodNames(java.lang.String[] aMethodNames)
aMethodNames
- array of ignored method namespublic java.lang.String[] getIgnoredMethodNames()
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |