com.puppycrawl.tools.checkstyle.checks.coding

Class IllegalThrowsCheck

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.coding.AbstractIllegalCheck

com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class IllegalThrowsCheck
extends AbstractIllegalCheck

Throwing java.lang.Error or java.lang.RuntimeException is almost never acceptable.

Check has following properties:

illegalClassNames - throw class names to reject.

ignoredMethodNames - names of methods to ignore.

ignoreOverriddenMethods - ignore checking overridden methods (marked with Override or java.lang.Override annotation) default value is true.

Author:

Oliver Burn, John Sirois, Aleksey Nesterenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
IllegalThrowsCheck() Creates new instance of the check.

Method Summary

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	setIgnoredMethodNames(String... methodNames) Set the list of ignore method names.
void	setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods) Sets ignoreOverriddenMethods property value.
void	visitToken(DetailAST detailAST) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.coding.AbstractIllegalCheck

isIllegalClassName, setIllegalClassNames

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

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

IllegalThrowsCheck

public IllegalThrowsCheck()

Creates new instance of the check.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST detailAST)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

detailAST - the token to process

setIgnoredMethodNames

public void setIgnoredMethodNames(String... methodNames)

Set the list of ignore method names.

Parameters:

methodNames - array of ignored method names

setIgnoreOverriddenMethods

public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods)

Sets ignoreOverriddenMethods property value.

Parameters:

ignoreOverriddenMethods - Check's property.