com.puppycrawl.tools.checkstyle.checks.coding

Class UnusedLocalVariableCheck.TypeDeclDesc

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc

Enclosing class:

UnusedLocalVariableCheck

private static class UnusedLocalVariableCheck.TypeDeclDesc
extends java.lang.Object

Maintains information about the type declaration. Any ast node of type TokenTypes.CLASS_DEF or TokenTypes.INTERFACE_DEF or TokenTypes.ENUM_DEF or TokenTypes.ANNOTATION_DEF or TokenTypes.RECORD_DEF is considered as a type declaration.

Field Summary

Fields

Modifier and Type	Field and Description
private int	depth Depth of nesting of type declaration.
private java.util.Deque<UnusedLocalVariableCheck.VariableDesc>	instanceAndClassVarStack A stack of type declaration's instance and static variables.
private java.lang.String	qualifiedName Complete type declaration name with package name and outer type declaration name.
private DetailAST	typeDeclAst Type declaration ast node.

Constructor Summary

Constructors

Constructor and Description
TypeDeclDesc(java.lang.String qualifiedName, int depth, DetailAST typeDeclAst) Create a new TypeDeclDesc instance.

Method Summary

Modifier and Type	Method and Description
void	addInstOrClassVar(UnusedLocalVariableCheck.VariableDesc variableDesc) Add an instance variable or class variable to the stack.
int	getDepth() Get the depth of type declaration.
java.lang.String	getQualifiedName() Get the complete type declaration name i.e.
DetailAST	getTypeDeclAst() Get the type declaration ast node.
java.util.Deque<UnusedLocalVariableCheck.VariableDesc>	getUpdatedCopyOfVarStack(DetailAST literalNewAst) Get the copy of variables in instanceAndClassVar stack with updated scope.

Methods inherited from class java.lang.Object

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

Field Detail

qualifiedName

private final java.lang.String qualifiedName

Complete type declaration name with package name and outer type declaration name.

depth

private final int depth

Depth of nesting of type declaration.

typeDeclAst

private final DetailAST typeDeclAst

Type declaration ast node.

instanceAndClassVarStack

private final java.util.Deque<UnusedLocalVariableCheck.VariableDesc> instanceAndClassVarStack

A stack of type declaration's instance and static variables.

Constructor Detail

TypeDeclDesc

TypeDeclDesc(java.lang.String qualifiedName,
             int depth,
             DetailAST typeDeclAst)

Create a new TypeDeclDesc instance.

Parameters:

qualifiedName - qualified name

depth - depth of nesting

typeDeclAst - type declaration ast node

Method Detail

getQualifiedName

public java.lang.String getQualifiedName()

Get the complete type declaration name i.e. type declaration name with package name and outer type declaration name.

Returns:

qualified class name

getDepth

public int getDepth()

Get the depth of type declaration.

Returns:

the depth of nesting of type declaration

getTypeDeclAst

public DetailAST getTypeDeclAst()

Get the type declaration ast node.

Returns:

ast node of the type declaration

getUpdatedCopyOfVarStack

public java.util.Deque<UnusedLocalVariableCheck.VariableDesc> getUpdatedCopyOfVarStack(DetailAST literalNewAst)

Get the copy of variables in instanceAndClassVar stack with updated scope.

Parameters:

literalNewAst - ast node of type TokenTypes.LITERAL_NEW

Returns:

copy of variables in instanceAndClassVar stack with updated scope.

addInstOrClassVar

public void addInstOrClassVar(UnusedLocalVariableCheck.VariableDesc variableDesc)

Add an instance variable or class variable to the stack.

Parameters:

variableDesc - variable to be added