org.sonar.plugins.java.api.tree.BaseTreeVisitor

org.sonar.java.ast.visitors.MethodNestingLevelVisitor

All Implemented Interfaces:: TreeVisitor

public class MethodNestingLevelVisitor extends BaseTreeVisitor

Used to determine the deepest nesting level of a method, calculated starting from 0 and increased by 1 for each if, while, for, foreach, lambda, switch, and try block found nested within each other. This was designed to be used as a metric collector for design-oriented rules.

Constructor Summary

Constructors

Constructor

Description

MethodNestingLevelVisitor()
Method Summary

Modifier and Type

Method

Description

int

getMaxNestingLevel(MethodTree tree)

void

visitDoWhileStatement(DoWhileStatementTree tree)

void

visitForEachStatement(ForEachStatement tree)

void

visitForStatement(ForStatementTree tree)

void

visitIfStatement(IfStatementTree tree)

void

visitLambdaExpression(LambdaExpressionTree lambdaExpressionTree)

void

visitMethod(MethodTree tree)

void

visitNewClass(NewClassTree tree)

void

visitSwitchStatement(SwitchStatementTree tree)

void

visitTryStatement(TryStatementTree tree)

void

visitWhileStatement(WhileStatementTree tree)

Methods inherited from class BaseTreeVisitor
scan, scan, scan, visitAnnotation, visitArrayAccessExpression, visitArrayDimension, visitArrayType, visitAssertStatement, visitAssignmentExpression, visitBinaryExpression, visitBlock, visitBreakStatement, visitCaseGroup, visitCaseLabel, visitCatch, visitClass, visitCompilationUnit, visitConditionalExpression, visitContinueStatement, visitDefaultPattern, visitEmptyStatement, visitEnumConstant, visitExportsDirectiveTree, visitExpressionStatement, visitGuardedPattern, visitIdentifier, visitImport, visitInstanceOf, visitLabeledStatement, visitLiteral, visitMemberSelectExpression, visitMethodInvocation, visitMethodReference, visitModifier, visitModule, visitNewArray, visitNullPattern, visitOpensDirective, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternInstanceOf, visitPrimitiveType, visitProvidesDirective, visitRecordPattern, visitRequiresDirectiveTree, visitReturnStatement, visitSwitchExpression, visitSynchronizedStatement, visitThrowStatement, visitTypeArguments, visitTypeCast, visitTypeParameter, visitTypeParameters, visitTypePattern, visitUnaryExpression, visitUnionType, visitUsesDirective, visitVariable, visitVarType, visitWildcard, visitYieldStatement

Modifier and Type

Method

Description

protected void

scan(List<? extends Tree> trees)

protected void

scan(ListTree<? extends Tree> listTree)

protected void

scan(Tree tree)

void

visitAnnotation(AnnotationTree annotationTree)

void

visitArrayAccessExpression(ArrayAccessExpressionTree tree)

void

visitArrayDimension(ArrayDimensionTree tree)

void

visitArrayType(ArrayTypeTree tree)

void

visitAssertStatement(AssertStatementTree tree)

void

visitAssignmentExpression(AssignmentExpressionTree tree)

void

visitBinaryExpression(BinaryExpressionTree tree)

void

visitBlock(BlockTree tree)

void

visitBreakStatement(BreakStatementTree tree)

void

visitCaseGroup(CaseGroupTree tree)

void

visitCaseLabel(CaseLabelTree tree)

void

visitCatch(CatchTree tree)

void

visitClass(ClassTree tree)

void

visitCompilationUnit(CompilationUnitTree tree)

void

visitConditionalExpression(ConditionalExpressionTree tree)

void

visitContinueStatement(ContinueStatementTree tree)

void

visitDefaultPattern(DefaultPatternTree tree)

void

visitEmptyStatement(EmptyStatementTree tree)

void

visitEnumConstant(EnumConstantTree tree)

void

visitExportsDirectiveTree(ExportsDirectiveTree tree)

void

visitExpressionStatement(ExpressionStatementTree tree)

void

visitGuardedPattern(GuardedPatternTree tree)

void

visitIdentifier(IdentifierTree tree)

void

visitImport(ImportTree tree)

void

visitInstanceOf(InstanceOfTree tree)

void

visitLabeledStatement(LabeledStatementTree tree)

void

visitLiteral(LiteralTree tree)

void

visitMemberSelectExpression(MemberSelectExpressionTree tree)

void

visitMethodInvocation(MethodInvocationTree tree)

void

visitMethodReference(MethodReferenceTree methodReferenceTree)

void

visitModifier(ModifiersTree modifiersTree)

void

visitModule(ModuleDeclarationTree module)

void

visitNewArray(NewArrayTree tree)

void

visitNullPattern(NullPatternTree tree)

void

visitOpensDirective(OpensDirectiveTree tree)

void

visitOther(Tree tree)

void

visitPackage(PackageDeclarationTree tree)

void

visitParameterizedType(ParameterizedTypeTree tree)

void

visitParenthesized(ParenthesizedTree tree)

void

visitPatternInstanceOf(PatternInstanceOfTree tree)

void

visitPrimitiveType(PrimitiveTypeTree tree)

void

visitProvidesDirective(ProvidesDirectiveTree tree)

void

visitRecordPattern(RecordPatternTree tree)

void

visitRequiresDirectiveTree(RequiresDirectiveTree tree)

void

visitReturnStatement(ReturnStatementTree tree)

void

visitSwitchExpression(SwitchExpressionTree tree)

void

visitSynchronizedStatement(SynchronizedStatementTree tree)

void

visitThrowStatement(ThrowStatementTree tree)

void

visitTypeArguments(TypeArguments trees)

void

visitTypeCast(TypeCastTree tree)

void

visitTypeParameter(TypeParameterTree typeParameter)

void

visitTypeParameters(TypeParameters trees)

void

visitTypePattern(TypePatternTree tree)

void

visitUnaryExpression(UnaryExpressionTree tree)

void

visitUnionType(UnionTypeTree tree)

void

visitUsesDirective(UsesDirectiveTree tree)

void

visitVariable(VariableTree tree)

void

visitVarType(VarTypeTree tree)

void

visitWildcard(WildcardTree tree)

void

visitYieldStatement(YieldStatementTree tree)

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MethodNestingLevelVisitor
  
  public MethodNestingLevelVisitor()
Method Details
- getMaxNestingLevel
  
  public int getMaxNestingLevel(MethodTree tree)
- visitIfStatement
  
  public void visitIfStatement(IfStatementTree tree)
  
  Specified by:
  
  visitIfStatement in interface TreeVisitor
  
  Overrides:
  
  visitIfStatement in class BaseTreeVisitor
- visitSwitchStatement
  
  public void visitSwitchStatement(SwitchStatementTree tree)
  
  Specified by:
  
  visitSwitchStatement in interface TreeVisitor
  
  Overrides:
  
  visitSwitchStatement in class BaseTreeVisitor
- visitTryStatement
  
  public void visitTryStatement(TryStatementTree tree)
  
  Specified by:
  
  visitTryStatement in interface TreeVisitor
  
  Overrides:
  
  visitTryStatement in class BaseTreeVisitor
- visitWhileStatement
  
  public void visitWhileStatement(WhileStatementTree tree)
  
  Specified by:
  
  visitWhileStatement in interface TreeVisitor
  
  Overrides:
  
  visitWhileStatement in class BaseTreeVisitor
- visitDoWhileStatement
  
  public void visitDoWhileStatement(DoWhileStatementTree tree)
  
  Specified by:
  
  visitDoWhileStatement in interface TreeVisitor
  
  Overrides:
  
  visitDoWhileStatement in class BaseTreeVisitor
- visitForStatement
  
  public void visitForStatement(ForStatementTree tree)
  
  Specified by:
  
  visitForStatement in interface TreeVisitor
  
  Overrides:
  
  visitForStatement in class BaseTreeVisitor
- visitLambdaExpression
  
  public void visitLambdaExpression(LambdaExpressionTree lambdaExpressionTree)
  
  Specified by:
  
  visitLambdaExpression in interface TreeVisitor
  
  Overrides:
  
  visitLambdaExpression in class BaseTreeVisitor
- visitForEachStatement
  
  public void visitForEachStatement(ForEachStatement tree)
  
  Specified by:
  
  visitForEachStatement in interface TreeVisitor
  
  Overrides:
  
  visitForEachStatement in class BaseTreeVisitor
- visitNewClass
  
  public void visitNewClass(NewClassTree tree)
  
  Specified by:
  
  visitNewClass in interface TreeVisitor
  
  Overrides:
  
  visitNewClass in class BaseTreeVisitor
- visitMethod
  
  public void visitMethod(MethodTree tree)
  
  Specified by:
  
  visitMethod in interface TreeVisitor
  
  Overrides:
  
  visitMethod in class BaseTreeVisitor

Class MethodNestingLevelVisitor

Constructor Summary

Method Summary

Methods inherited from class BaseTreeVisitor

Methods inherited from class Object

Constructor Details

MethodNestingLevelVisitor

Method Details

getMaxNestingLevel

visitIfStatement

visitSwitchStatement

visitTryStatement

visitWhileStatement

visitDoWhileStatement

visitForStatement

visitLambdaExpression

visitForEachStatement

visitNewClass

visitMethod