Class UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails

Enclosing class:

UnusedCatchParameterShouldBeUnnamedCheck

private static final class UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
extends Object

Maintains information about the catch parameter.

Since:

10.18.0

Field Summary

Fields

Modifier and Type	Field	Description
private final String	name	The name of the catch parameter.
private final DetailAST	parameterDefinition	Ast of type TokenTypes.PARAMETER_DEF to use it when logging.
private boolean	used	Is the variable used.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CatchParameterDetails(DetailAST enclosingCatchClause)	Create a new catch parameter instance.

Method Summary

Modifier and Type	Method	Description
private String	getName()	Get the name of the catch parameter.
private DetailAST	getParameterDefinition()	Get the parameter definition token of the catch parameter represented by ast of type TokenTypes.PARAMETER_DEF.
private boolean	isUsed()	Check if the catch parameter is used.
private void	registerAsUsed()	Register the catch parameter as used.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

private final String name

The name of the catch parameter.

parameterDefinition

private final DetailAST parameterDefinition

Ast of type TokenTypes.PARAMETER_DEF to use it when logging.

used

private boolean used

Is the variable used.

Constructor Details

CatchParameterDetails

private CatchParameterDetails(DetailAST enclosingCatchClause)

Create a new catch parameter instance.

Parameters:

enclosingCatchClause - ast of type TokenTypes.LITERAL_CATCH

Method Details

registerAsUsed

private void registerAsUsed()

Register the catch parameter as used.

getName

private String getName()

Get the name of the catch parameter.

Returns:

the name of the catch parameter

isUsed

private boolean isUsed()

Check if the catch parameter is used.

Returns:

true if the catch parameter is used

getParameterDefinition

private DetailAST getParameterDefinition()

Get the parameter definition token of the catch parameter represented by ast of type TokenTypes.PARAMETER_DEF.

Returns:

the ast of type TokenTypes.PARAMETER_DEF