Package com.puppycrawl.tools.checkstyle.checks.coding

Class ReturnCountCheck.Context

java.lang.Object
com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
Enclosing class:
ReturnCountCheck
private class ReturnCountCheck.Context extends Object
Class to encapsulate information about one method.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final boolean
    checking
    Whether we should check this method or not.
    private int
    count
    Counter for return statements.
    private boolean
    isVoidContext
    Identifies if context is void.
    private Integer
    maxAllowed
    Maximum allowed number of return statements.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Context(boolean checking)
    Creates new method context.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkCount(DetailAST ast)
    Checks if number of return statements in the method are more than allowed.
    void
    visitLiteralReturn(int maxAssigned, Boolean voidReturn)
    Increase the number of return statements and set context return type.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • checking

      private final boolean checking
      Whether we should check this method or not.

    • count

      private int count
      Counter for return statements.

    • maxAllowed

      private Integer maxAllowed
      Maximum allowed number of return statements.

    • isVoidContext

      private boolean isVoidContext
      Identifies if context is void.

  • Constructor Details

    • Context

      Context(boolean checking)
      Creates new method context.
      Parameters:
      checking - should we check this method or not.

  • Method Details

    • visitLiteralReturn

      public void visitLiteralReturn(int maxAssigned, Boolean voidReturn)
      Increase the number of return statements and set context return type.
      Parameters:
      maxAssigned - Maximum allowed number of return statements.
      voidReturn - Identifies if context is void.

    • checkCount

      public void checkCount(DetailAST ast)
      Checks if number of return statements in the method are more than allowed.
      Parameters:
      ast - method def associated with this context.