Package: org.apache.groovy.contracts.ast.visitor

## [Java] Class ContractElementVisitor

- org.apache.groovy.contracts.ast.visitor.ContractElementVisitor

- All Implemented Interfaces and Traits:
    ASTNodeMetaData

      public class ContractElementVisitor
      extends BaseVisitor
      implements ASTNodeMetaData

  Checks whether the given ClassNode is relevant for further processing.

- - Inherited fields
    Fields inherited from class | Fields
    --- | ---
    `class BaseVisitor` | `GCONTRACTS_ENABLED_VAR, sourceUnit`

  - ### Constructor Summary

    Constructors
    Constructor and description
    `ContractElementVisitor(SourceUnit sourceUnit, ReaderSource source)` Creates a visitor that detects whether a class participates in contract processing.

  - ### Methods Summary

    Methods
    Type Params | Return Type | Name and description
    --- | --- | ---
    `` | `public boolean` | `isFoundContractElement()` Indicates whether any contract element was detected while traversing the class hierarchy.
    `` | `public void` | `visitClass(ClassNode node)` Visits the supplied class and its hierarchy until any contract element is found.
    `` | `protected void` | `visitConstructorOrMethod(MethodNode methodNode, boolean isConstructor)` Checks whether the visited constructor or method already has rewritten contract metadata.

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class BaseVisitor` | `asConditionExecution, getOriginalCondition, getReplacedCondition, getSourceUnit, replaceCondition`
    `class ClassCodeVisitorSupport` | `addError, getSourceUnit, visitAnnotation, visitAnnotations, visitAnnotations, visitAssertStatement, visitBlockStatement, visitBreakStatement, visitCaseStatement, visitCatchStatement, visitClass, visitClassCodeContainer, visitClosureExpression, visitConstructor, visitConstructorOrMethod, visitContinueStatement, visitDeclarationExpression, visitDoWhileLoop, visitExpressionStatement, visitField, visitForLoop, visitIfElse, visitImports, visitMethod, visitObjectInitializerStatements, visitPackage, visitProperty, visitReturnStatement, visitStatement, visitStatementAnnotations, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitTryCatchFinally, visitWhileLoop, visitYieldStatement`
    `class CodeVisitorSupport` | `afterSwitchCaseStatementsVisited, afterSwitchCaseStatementsVisited, afterSwitchConditionExpressionVisited, afterSwitchConditionExpressionVisited, visitArgumentlistExpression, visitArrayExpression, visitAssertStatement, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBlockStatement, visitBooleanExpression, visitBreakStatement, visitBytecodeExpression, visitCaseStatement, visitCastExpression, visitCatchStatement, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitContinueStatement, visitDeclarationExpression, visitDoWhileLoop, visitEmptyStatement, visitExpressionStatement, visitFieldExpression, visitForLoop, visitGStringExpression, visitIfElse, visitLambdaExpression, visitListExpression, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitMethodReferenceExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitReturnStatement, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitSwitch, visitSwitchExpression, visitSynchronizedStatement, visitTernaryExpression, visitThrowStatement, visitTryCatchFinally, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression, visitWhileLoop, visitYieldStatement`

- - ### Constructor Detail

    - #### public ContractElementVisitor(SourceUnit sourceUnit, ReaderSource source)

      Creates a visitor that detects whether a class participates in contract processing.

      Parameters:
        `sourceUnit` - the source unit currently being transformed
        `source` - the reader source backing the source unit

  - ### Method Detail

    - #### public boolean isFoundContractElement()

      Indicates whether any contract element was detected while traversing the class hierarchy.

      Returns:
        `true` once a contract element has been found

    - #### public void visitClass(ClassNode node)

      Visits the supplied class and its hierarchy until any contract element is found.

      Parameters:
        `node` - the class to inspect

    - #### protected void visitConstructorOrMethod(MethodNode methodNode, boolean isConstructor)

      Checks whether the visited constructor or method already has rewritten contract metadata.

      Parameters:
        `methodNode` - the method or constructor being inspected
        `isConstructor` - whether the node represents a constructor