BooleanExpressionComplexityCheck

java.lang.Object
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.AbstractCheck
    - - com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck

All Implemented Interfaces:

Configurable, Contextualizable
```
public final class BooleanExpressionComplexityCheck
extends AbstractCheck
```
Restricts nested boolean operators (&&, ||, &, | and ^) to a specified depth (default = 3). Note: &, | and ^ are not checked if they are part of constructor or method call because they can be applied to non boolean variables and Checkstyle does not know types of methods from different classes.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class BooleanExpressionComplexityCheck.Context
Represents context (method/expression) in which we check complexity.

Nested Classes
Modifier and Type	Class and Description
`private class`	`BooleanExpressionComplexityCheck.Context` Represents context (method/expression) in which we check complexity.

Field Summary

Fields
Modifier and Type	Field and Description
`private BooleanExpressionComplexityCheck.Context`	`context` Current context.
`private java.util.Deque<BooleanExpressionComplexityCheck.Context>`	`contextStack` Stack of contexts.
`private static int`	`DEFAULT_MAX` Default allowed complexity.
`private int`	`max` Maximum allowed complexity.
`static java.lang.String`	`MSG_KEY` A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors
Constructor and Description

BooleanExpressionComplexityCheck()
Creates new instance of the check.

Constructors
Constructor and Description
`BooleanExpressionComplexityCheck()` Creates new instance of the check.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`getAcceptableTokens()` The configurable token set.
`int[]`	`getDefaultTokens()` Returns the default token a check is interested in.
`int`	`getMax()` Getter for maximum allowed complexity.
`int[]`	`getRequiredTokens()` The tokens that this check must be registered for.
`private static boolean`	`isPassedInParameter(DetailAST logicalOperator)` Checks if logical operator is part of constructor or method call.
`private static boolean`	`isPipeOperator(DetailAST binaryOr)` Checks if `binary OR` is applied to exceptions in multi-catch (pipe-syntax).
`private void`	`leaveExpr(DetailAST ast)` Restores previous context.
`private void`	`leaveMethodDef()` Removes old context.
`void`	`leaveToken(DetailAST ast)` Called after all the child nodes have been process.
`void`	`setMax(int max)` Setter for maximum allowed complexity.
`private void`	`visitExpr()` Creates and pushes new context.
`private void`	`visitMethodDef(DetailAST ast)` Creates new context for a given method.
`void`	`visitToken(DetailAST ast)` Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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 java.lang.String MSG_KEY
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX
```
private static final int DEFAULT_MAX
```
    Default allowed complexity.
    
    See Also:
    
    Constant Field Values
  - contextStack
```
private final java.util.Deque<BooleanExpressionComplexityCheck.Context> contextStack
```
    Stack of contexts.
  - max
```
private int max
```
    Maximum allowed complexity.
  - context
```
private BooleanExpressionComplexityCheck.Context context
```
    Current context.
- Constructor Detail
  - BooleanExpressionComplexityCheck
```
public BooleanExpressionComplexityCheck()
```
    Creates new instance of the check.
- Method Detail
  - getDefaultTokens
```
public int[] getDefaultTokens()
```
    Description copied from class: AbstractCheck
    
    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 AbstractCheck
    
    Returns:
    
    the default tokens
    
    See Also:
    
    TokenTypes
  - getRequiredTokens
```
public int[] getRequiredTokens()
```
    Description copied from class: AbstractCheck
    
    The tokens that this check must be registered for.
    
    Specified by:
    
    getRequiredTokens in class AbstractCheck
    
    Returns:
    
    the token set this must be registered for.
    
    See Also:
    
    TokenTypes
  - getAcceptableTokens
```
public int[] getAcceptableTokens()
```
    Description copied from class: AbstractCheck
    
    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.
    
    Specified by:
    
    getAcceptableTokens in class AbstractCheck
    
    Returns:
    
    the token set this check is designed for.
    
    See Also:
    
    TokenTypes
  - getMax
```
public int getMax()
```
    Getter for maximum allowed complexity.
    
    Returns:
    
    value of maximum allowed complexity.
  - setMax
```
public void setMax(int max)
```
    Setter for maximum allowed complexity.
    
    Parameters:
    
    max - new maximum allowed complexity.
  - visitToken
```
public void visitToken(DetailAST ast)
```
    Description copied from class: AbstractCheck
    
    Called to process a token.
    
    Overrides:
    
    visitToken in class AbstractCheck
    
    Parameters:
    
    ast - the token to process
  - isPassedInParameter
```
private static boolean isPassedInParameter(DetailAST logicalOperator)
```
    Checks if logical operator is part of constructor or method call.
    
    Parameters:
    
    logicalOperator - logical operator
    
    Returns:
    
    true if logical operator is part of constructor or method call
  - isPipeOperator
```
private static boolean isPipeOperator(DetailAST binaryOr)
```
    Checks if binary OR is applied to exceptions in multi-catch (pipe-syntax).
    
    Parameters:
    
    binaryOr - binary or
    
    Returns:
    
    true if binary or is applied to exceptions in multi-catch.
  - leaveToken
```
public void leaveToken(DetailAST ast)
```
    Description copied from class: AbstractCheck
    
    Called after all the child nodes have been process.
    
    Overrides:
    
    leaveToken in class AbstractCheck
    
    Parameters:
    
    ast - the token leaving
  - visitMethodDef
```
private void visitMethodDef(DetailAST ast)
```
    Creates new context for a given method.
    
    Parameters:
    
    ast - a method we start to check.
  - leaveMethodDef
```
private void leaveMethodDef()
```
    Removes old context.
  - visitExpr
```
private void visitExpr()
```
    Creates and pushes new context.
  - leaveExpr
```
private void leaveExpr(DetailAST ast)
```
    Restores previous context.
    
    Parameters:
    
    ast - expression we leave.

Class BooleanExpressionComplexityCheck

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

MSG_KEY

DEFAULT_MAX

contextStack

max

context

Constructor Detail

BooleanExpressionComplexityCheck

Method Detail

getDefaultTokens

getRequiredTokens

getAcceptableTokens

getMax

setMax

visitToken

isPassedInParameter

isPipeOperator

leaveToken

visitMethodDef

leaveMethodDef

visitExpr

leaveExpr