|
|||||||||||
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.coding.IllegalInstantiationCheck
Checks for illegal instantiations where a factory method is preferred.
Rationale: Depending on the project, for some classes it might be preferable to create instances through factory methods rather than calling the constructor.
A simple example is the java.lang.Boolean class, to save memory and CPU cycles it is preferable to use the predeifined constants TRUE and FALSE. Constructor invocations should be replaced by calls to Boolean.valueOf().
Some extremely performance sensitive projects may require the use of factory methods for other classes as well, to enforce the usage of number caches or object pools.
Limitations: It is currently not possible to specify array classes.
An example of how to configure the check is:
<module name="IllegalInstantiation"/>
Constructor Summary | |
IllegalInstantiationCheck()
|
Method Summary | |
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree. |
void |
finishTree(DetailAST aRootAST)
Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree. |
int[] |
getAcceptableTokens()
Prevent user from changing tokens in the configuration. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens. |
int[] |
getRequiredTokens()
The tokens that this check must be registered for. |
void |
setClasses(String aClassNames)
Sets the classes that are illegal to instantiate. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
destroy, getClassLoader, getFileContents, getLines, 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 IllegalInstantiationCheck()
Method Detail |
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
getAcceptableTokens
in class Check
Check
public int[] getRequiredTokens()
getRequiredTokens
in class Check
TokenTypes
public void beginTree(DetailAST aRootAST)
beginTree
in class Check
aRootAST
- the root of the treepublic void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to processpublic void finishTree(DetailAST aRootAST)
finishTree
in class Check
aRootAST
- the root of the treepublic void setClasses(String aClassNames)
aClassNames
- a comma seperate list of class names
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |