Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.puppycrawl.tools.checkstyle.checks.coding

Class MagicNumberCheck

Implemented Interfaces:
Configurable, Contextualizable
public class MagicNumberCheck
extends Check
Checks for magic numbers.

An example of how to configure the check to ignore numbers 0, 1, 1.5, 2: 

 <module name="MagicNumber">
    <property name="ignoreNumbers" value="0, 1, 1.5, 2"/>
 </module>

Authors:
Rick Giles
Lars K?hne

Method Summary

int[]
getDefaultTokens()
void
setIgnoreNumbers(double[] aList)
Sets the numbers to ignore in the check.
void
visitToken(DetailAST aAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, 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

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

See Also:
Check

setIgnoreNumbers

public void setIgnoreNumbers(double[] aList)
Sets the numbers to ignore in the check. BeanUtils converts numeric token list to double array automatically.

Parameters:
aList - list of numbers to ignore.

visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

See Also:
Check

Overview Package Class Use Tree Index Deprecated About
Back to the Checkstyle Home Page