Index

A B C D E F G H I J L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addAssertionCallStatementToReturnStatement(BlockStatement, ReturnStatement, Statement) - Static method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility

AddAssertionCallStatementToReturnStatementVisitor(ReturnStatement, Statement) - Constructor for class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.AddAssertionCallStatementToReturnStatementVisitor

addCallsToSuperMethodNodeAnnotationClosure(ClassNode, MethodNode, Class<? extends Annotation>, BooleanExpression, boolean) - Method in class org.apache.groovy.contracts.generation.BaseGenerator

addError(String, ASTNode) - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

addInvariantAssertionStatement(ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.generation.ClassInvariantGenerator

Adds the current class-invariant to the given method.

addOldVariableMethodNode(ClassNode) - Static method in class org.apache.groovy.contracts.generation.OldVariableGenerationUtility

Creates a synthetic method handling generation of the old variable map.

addOldVariablesMethod(ClassNode) - Method in class org.apache.groovy.contracts.generation.PostconditionGenerator

Adds a synthetic method to the given classNode which can be used to create a map of most instance variables found in this class.

AddResultReturnStatementVisitor(ReturnStatement, ClassNode, BlockStatement) - Constructor for class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.AddResultReturnStatementVisitor

afterProcessingClassNode(ProcessingContextInformation, ClassNode) - Method in class org.apache.groovy.contracts.common.base.BaseLifecycle

afterProcessingClassNode(ProcessingContextInformation, ClassNode) - Method in interface org.apache.groovy.contracts.common.spi.Lifecycle

afterProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.base.BaseLifecycle

afterProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.impl.lc.ClassInvariantLifecycle

afterProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.impl.lc.PostconditionLifecycle

afterProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in interface org.apache.groovy.contracts.common.spi.Lifecycle

afterProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.base.BaseLifecycle

afterProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.impl.lc.ClassInvariantLifecycle

afterProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.impl.lc.PostconditionLifecycle

afterProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.impl.lc.PreconditionLifecycle

afterProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in interface org.apache.groovy.contracts.common.spi.Lifecycle

and(MethodNode, T) - Method in class org.apache.groovy.contracts.domain.AssertionMap

and(T) - Method in class org.apache.groovy.contracts.domain.Assertion

AnnotationClosureVisitor - Class in org.apache.groovy.contracts.ast.visitor

Visits interfaces & classes and looks for @Requires or @Ensures and creates Closure classes for the annotation closures.

AnnotationClosureVisitor(SourceUnit, ReaderSource) - Constructor for class org.apache.groovy.contracts.ast.visitor.AnnotationClosureVisitor

AnnotationContractParameterVisitor - Class in org.apache.groovy.contracts.ast.visitor

This BaseVisitor walks up the class hierarchy for the given ClassNode and adds ContractElement annotations to method parameters.

AnnotationContractParameterVisitor(SourceUnit, ReaderSource) - Constructor for class org.apache.groovy.contracts.ast.visitor.AnnotationContractParameterVisitor

AnnotationProcessor - Class in org.apache.groovy.contracts.common.spi

Base class for modifying the internal domain model, starting at Contract, and adding parts to it.

AnnotationProcessor() - Constructor for class org.apache.groovy.contracts.common.spi.AnnotationProcessor

AnnotationProcessorImplementation - Annotation Type in org.apache.groovy.contracts.annotations.meta

Indicates what AnnotationProcessor implementation should be used to process the correlating annotation.

AnnotationProcessorVisitor - Class in org.apache.groovy.contracts.ast.visitor

Visits annotations of meta-type ContractElement and applies the AST transformations of the underlying AnnotationProcessor implementation.

AnnotationProcessorVisitor(SourceUnit, ReaderSource, ProcessingContextInformation) - Constructor for class org.apache.groovy.contracts.ast.visitor.AnnotationProcessorVisitor

AnnotationUtils - Class in org.apache.groovy.contracts.util

Helper methods for reading/getting AnnotationNode instances.

AnnotationUtils() - Constructor for class org.apache.groovy.contracts.util.AnnotationUtils

Assertion<T extends Assertion> - Class in org.apache.groovy.contracts.domain

Base class for all assertion types.

Assertion() - Constructor for class org.apache.groovy.contracts.domain.Assertion

Assertion(BlockStatement, BooleanExpression) - Constructor for class org.apache.groovy.contracts.domain.Assertion

AssertionMap<T extends Assertion<T>> - Class in org.apache.groovy.contracts.domain

AssertionMap() - Constructor for class org.apache.groovy.contracts.domain.AssertionMap

AssertionViolation - Error in org.apache.groovy.contracts

Abstract base class for all assertion violations.

AssertionViolation() - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(boolean) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(char) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(double) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(float) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(int) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(long) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertionViolation(Object) - Constructor for error org.apache.groovy.contracts.AssertionViolation

AssertStatementCreationUtility - Class in org.apache.groovy.contracts.generation

Central place to create AssertStatement instances in groovy-contracts.

AssertStatementCreationUtility() - Constructor for class org.apache.groovy.contracts.generation.AssertStatementCreationUtility

AssertStatementCreationUtility.AddAssertionCallStatementToReturnStatementVisitor - Class in org.apache.groovy.contracts.generation

Replaces a given ReturnStatement with the appropriate assertion call statement and returns a result variable expression.

AssertStatementCreationUtility.AddResultReturnStatementVisitor - Class in org.apache.groovy.contracts.generation

Replaces a given ReturnStatement with the appropriate assertion call statement and returns a result variable expression.

AssertStatementCreationUtility.ReturnStatementVisitor - Class in org.apache.groovy.contracts.generation

Collects all ReturnStatement instances from a given code block.

ASTNodeMetaData - Interface in org.apache.groovy.contracts.ast.visitor

Holds all constants to be used as AST node metadata keys.

B

BaseASTTransformation - Class in org.apache.groovy.contracts.ast

Base AST transformation encapsulating all common helper methods and implementing ASTTransformation.

BaseASTTransformation() - Constructor for class org.apache.groovy.contracts.ast.BaseASTTransformation

BaseGenerator - Class in org.apache.groovy.contracts.generation

Base class for groovy-contracts code generators.

BaseGenerator(ReaderSource) - Constructor for class org.apache.groovy.contracts.generation.BaseGenerator

BaseLifecycle - Class in org.apache.groovy.contracts.common.base

Base implementation class for interface Lifecycle.

BaseLifecycle() - Constructor for class org.apache.groovy.contracts.common.base.BaseLifecycle

BaseVisitor - Class in org.apache.groovy.contracts.ast.visitor

Base class for ClassCodeVisitorSupport descendants.

BaseVisitor(SourceUnit, ReaderSource) - Constructor for class org.apache.groovy.contracts.ast.visitor.BaseVisitor

beforeProcessingClassNode(ProcessingContextInformation, ClassNode) - Method in class org.apache.groovy.contracts.common.base.BaseLifecycle

beforeProcessingClassNode(ProcessingContextInformation, ClassNode) - Method in class org.apache.groovy.contracts.common.impl.lc.PostconditionLifecycle

beforeProcessingClassNode(ProcessingContextInformation, ClassNode) - Method in interface org.apache.groovy.contracts.common.spi.Lifecycle

beforeProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.base.BaseLifecycle

beforeProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.impl.lc.PreconditionLifecycle

beforeProcessingConstructorNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in interface org.apache.groovy.contracts.common.spi.Lifecycle

beforeProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.common.base.BaseLifecycle

beforeProcessingMethodNode(ProcessingContextInformation, ClassNode, MethodNode) - Method in interface org.apache.groovy.contracts.common.spi.Lifecycle

booleanExpression() - Method in class org.apache.groovy.contracts.domain.Assertion

C

CandidateChecks - Class in org.apache.groovy.contracts.generation

Functions in this class are used to determine whether a certain AST node fulfills certain assertion requirements.

CandidateChecks() - Constructor for class org.apache.groovy.contracts.generation.CandidateChecks

checkAssertionsEnabled(String) - Static method in class org.apache.groovy.contracts.generation.Configurator

This static method is used within generated code to check whether assertions have been disabled for the current class or not.

CircularAssertionCallException - Exception in org.apache.groovy.contracts

Thrown whenever pre- or post-conditions are called in a cyclic way.

CircularAssertionCallException() - Constructor for exception org.apache.groovy.contracts.CircularAssertionCallException

CircularAssertionCallException(String) - Constructor for exception org.apache.groovy.contracts.CircularAssertionCallException

CircularAssertionCallException(String, Throwable) - Constructor for exception org.apache.groovy.contracts.CircularAssertionCallException

CircularAssertionCallException(Throwable) - Constructor for exception org.apache.groovy.contracts.CircularAssertionCallException

classInvariant() - Method in class org.apache.groovy.contracts.domain.Contract

ClassInvariant - Class in org.apache.groovy.contracts.domain

A class-invariant assertion.

ClassInvariant - Annotation Type in org.apache.groovy.contracts.annotations.meta

Indicates that annotations being marked as @ClassInvariant are to be treated as class invariant modifying annotations.

ClassInvariant() - Constructor for class org.apache.groovy.contracts.domain.ClassInvariant

ClassInvariant(BlockStatement, BooleanExpression) - Constructor for class org.apache.groovy.contracts.domain.ClassInvariant

ClassInvariantAnnotationProcessor - Class in org.apache.groovy.contracts.common.impl

Internal AnnotationProcessor implementation for class-invariants.

ClassInvariantAnnotationProcessor() - Constructor for class org.apache.groovy.contracts.common.impl.ClassInvariantAnnotationProcessor

ClassInvariantGenerator - Class in org.apache.groovy.contracts.generation

Code generator for class invariants.

ClassInvariantGenerator(ReaderSource) - Constructor for class org.apache.groovy.contracts.generation.ClassInvariantGenerator

ClassInvariantLifecycle - Class in org.apache.groovy.contracts.common.impl.lc

Internal Lifecycle implementation for class-invariants.

ClassInvariantLifecycle() - Constructor for class org.apache.groovy.contracts.common.impl.lc.ClassInvariantLifecycle

ClassInvariantViolation - Error in org.apache.groovy.contracts

Thrown whenever a class invariant violation occurs.

ClassInvariantViolation() - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(boolean) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(char) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(double) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(float) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(int) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(long) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

ClassInvariantViolation(Object) - Constructor for error org.apache.groovy.contracts.ClassInvariantViolation

classNode() - Method in class org.apache.groovy.contracts.domain.Contract

clear(String, String, String, boolean) - Static method in class org.apache.groovy.contracts.generation.ContractExecutionTracker

CLOSURE_ATTRIBUTE_NAME - Static variable in class org.apache.groovy.contracts.ast.visitor.BaseVisitor

CLOSURE_REPLACED - Static variable in interface org.apache.groovy.contracts.ast.visitor.ASTNodeMetaData

ClosureExpressionEvaluationASTTransformation - Class in org.apache.groovy.contracts.ast

Evaluates ClosureExpression instances in as actual annotation parameters and generates special contract closure classes from them.

ClosureExpressionEvaluationASTTransformation() - Constructor for class org.apache.groovy.contracts.ast.ClosureExpressionEvaluationASTTransformation

ConfigurationSetup - Class in org.apache.groovy.contracts.ast.visitor

Makes some initialization in order to use the Configurator for determining which assertions in what packages will be executed.

ConfigurationSetup() - Constructor for class org.apache.groovy.contracts.ast.visitor.ConfigurationSetup

Configurator - Class in org.apache.groovy.contracts.generation

Handles -ea and -da runtime input arguments for enabling and disabling contract elements.

Configurator() - Constructor for class org.apache.groovy.contracts.generation.Configurator

contains(MethodNode) - Method in class org.apache.groovy.contracts.domain.AssertionMap

contract() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

Contract - Class in org.apache.groovy.contracts.domain

Represents a contract between a supplier and a customer of a class.

Contract(ClassNode) - Constructor for class org.apache.groovy.contracts.domain.Contract

ContractClosureWriter - Class in org.apache.groovy.contracts.classgen.asm

Replaces annotation closures with closure implementation classes.

ContractClosureWriter() - Constructor for class org.apache.groovy.contracts.classgen.asm.ContractClosureWriter

Contracted - Annotation Type in groovy.contracts

Package-level and class-level annotation indicating that the package is enabled for class-invariants, pre- and post-conditions.

ContractElement - Annotation Type in org.apache.groovy.contracts.annotations.meta

Indicates that annotations being marked as @ContractElement are to be used by some contract element being either a class-invariant, pre- or post-condition.

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

Checks whether the given ClassNode is relevant for further processing.

ContractElementVisitor(SourceUnit, ReaderSource) - Constructor for class org.apache.groovy.contracts.ast.visitor.ContractElementVisitor

ContractExecution(String, String, String, boolean) - Constructor for class org.apache.groovy.contracts.generation.ContractExecutionTracker.ContractExecution

ContractExecutionTracker - Class in org.apache.groovy.contracts.generation

Keeps track of contract executions to avoid cyclic contract checks.

ContractExecutionTracker() - Constructor for class org.apache.groovy.contracts.generation.ContractExecutionTracker

ContractExecutionTracker.ContractExecution - Class in org.apache.groovy.contracts.generation

couldBeContractElementMethodNode(ClassNode, MethodNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Checks whether the given MethodNode could be a candidate for an arbitrary ContractElement annotation.

createClosureClass(ClassNode, MethodNode, ClosureExpression, boolean, boolean, int) - Method in class org.apache.groovy.contracts.classgen.asm.ContractClosureWriter

createSetterBlock(ClassNode, FieldNode, Parameter) - Method in class org.apache.groovy.contracts.ast.visitor.DynamicSetterInjectionVisitor

D

DEFAULT - Static variable in class org.apache.groovy.contracts.domain.ClassInvariant

deinit() - Static method in class org.apache.groovy.contracts.ViolationTracker

DISABLE_PACKAGE_ASSERTIONS - Static variable in class org.apache.groovy.contracts.generation.Configurator

DISABLED_ASSERTIONS - Static variable in class org.apache.groovy.contracts.generation.Configurator

DomainModelInjectionVisitor - Class in org.apache.groovy.contracts.ast.visitor

Visits the given ClassNode and injects the current Contract into the given AST nodes.

DomainModelInjectionVisitor(SourceUnit, ReaderSource, ProcessingContextInformation) - Constructor for class org.apache.groovy.contracts.ast.visitor.DomainModelInjectionVisitor

DynamicSetterInjectionVisitor - Class in org.apache.groovy.contracts.ast.visitor

Implements contract support for setter methods and default constructors of POGOs.

DynamicSetterInjectionVisitor(SourceUnit, ReaderSource) - Constructor for class org.apache.groovy.contracts.ast.visitor.DynamicSetterInjectionVisitor

E

ENABLE_PACKAGE_ASSERTIONS - Static variable in class org.apache.groovy.contracts.generation.Configurator

ENABLED_ASSERTIONS - Static variable in class org.apache.groovy.contracts.generation.Configurator

Ensures - Annotation Type in groovy.contracts

Represents a method postcondition.

EnsuresAnnotationProcessor - Class in org.apache.groovy.contracts.common.impl

Internal AnnotationProcessor implementation for post-conditions.

EnsuresAnnotationProcessor() - Constructor for class org.apache.groovy.contracts.common.impl.EnsuresAnnotationProcessor

equals(Object) - Method in class org.apache.groovy.contracts.generation.ContractExecutionTracker.ContractExecution

ExpressionUtils - Class in org.apache.groovy.contracts.util

Internal utility class for extracting a boolean expression from the given expression or statement.

F

fieldValue(Object, String, Class<T>) - Static method in class org.apache.groovy.contracts.util.FieldValues

FieldValues - Class in org.apache.groovy.contracts.util

This utility is meant to be used to replace direct calls to private field variables in class invariants.

FieldValues() - Constructor for class org.apache.groovy.contracts.util.FieldValues

first() - Method in class org.apache.groovy.contracts.ViolationTracker

G

GCONTRACTS_ENABLED_VAR - Static variable in class org.apache.groovy.contracts.ast.visitor.BaseVisitor

GContractsASTTransformation - Class in org.apache.groovy.contracts.ast

Custom AST transformation that removes closure annotations of Invariant, Requires and Ensures and adds Java assertions executing the closure-code.

GContractsASTTransformation() - Constructor for class org.apache.groovy.contracts.ast.GContractsASTTransformation

generateDefaultPostconditionStatement(ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.generation.PostconditionGenerator

Adds a default postcondition if a postcondition has already been defined for this MethodNode in a super-class.

generateDefaultPreconditionStatement(ClassNode, MethodNode) - Method in class org.apache.groovy.contracts.generation.PreconditionGenerator

Generates the default precondition statement for MethodNode instances with the Precondition annotation.

generateInvariantAssertionStatement(ClassNode, ClassInvariant) - Method in class org.apache.groovy.contracts.generation.ClassInvariantGenerator

Reads the Invariant boolean expression and generates a synthetic method holding this class invariant.

generatePostconditionAssertionStatement(MethodNode, Postcondition) - Method in class org.apache.groovy.contracts.generation.PostconditionGenerator

Injects a postcondition assertion statement in the given method, based on the booleanExpression.

generatePreconditionAssertionStatement(MethodNode, Precondition) - Method in class org.apache.groovy.contracts.generation.PreconditionGenerator

Injects a precondition assertion statement in the given method, based on the given annotation of type Requires.

generateTryCatchBlock(ClassNode, String, Statement) - Static method in class org.apache.groovy.contracts.generation.TryCatchBlockGenerator

generateTryCatchBlockForInlineMode(ClassNode, String, Statement) - Static method in class org.apache.groovy.contracts.generation.TryCatchBlockGenerator

get(String) - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

get(MethodNode) - Method in class org.apache.groovy.contracts.domain.AssertionMap

getAnnotationNodeInHierarchyWithMetaAnnotation(ClassNode, ClassNode) - Static method in class org.apache.groovy.contracts.util.AnnotationUtils

Gets the next AnnotationNode instance in the inheritance line which is annotated with the given Annotation class anno.

getAnnotationNodeInHierarchyWithMetaAnnotation(ClassNode, MethodNode, ClassNode) - Static method in class org.apache.groovy.contracts.util.AnnotationUtils

Checks whether there exists a MethodNode up the inheritance tree where exists an annotation which is annotated with metaAnnotationClassNode.

getAssertionStatement(BooleanExpression) - Static method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility

Reusable method for creating assert statements for the given booleanExpression.

getAssertionStatements(List<BooleanExpression>) - Static method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility

Reusable method for creating assert statements for the given booleanExpression.

getBooleanExpression(List<BooleanExpression>) - Static method in class org.apache.groovy.contracts.util.ExpressionUtils

getBooleanExpression(ClosureExpression) - Static method in class org.apache.groovy.contracts.util.ExpressionUtils

Returns all BooleanExpression instances found in the given ClosureExpression.

getBooleanExpressionsFromAssertionStatements(BlockStatement) - Static method in class org.apache.groovy.contracts.util.ExpressionUtils

Returns all BooleanExpression instances found in the given BlockStatement.

getInlineModeBlockStatement(BlockStatement) - Method in class org.apache.groovy.contracts.generation.BaseGenerator

getInvariantMethodName(ClassNode) - Static method in class org.apache.groovy.contracts.generation.BaseGenerator

getInvariantMethodNode(ClassNode) - Static method in class org.apache.groovy.contracts.generation.BaseGenerator

getReaderSource(SourceUnit) - Method in class org.apache.groovy.contracts.ast.BaseASTTransformation

Reads the protected source1 instance variable of SourceUnit.

getReturnStatements() - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.ReturnStatementVisitor

getReturnStatements(MethodNode) - Static method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility

Gets a list of ReturnStatement instances from the given MethodNode.

getSourceUnit() - Method in class org.apache.groovy.contracts.ast.visitor.BaseVisitor

getSourceUnit() - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.AddAssertionCallStatementToReturnStatementVisitor

getSourceUnit() - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.AddResultReturnStatementVisitor

getSourceUnit() - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.ReturnStatementVisitor

groovy.contracts - package groovy.contracts

H

hasAnnotationOfType(AnnotatedNode, String) - Static method in class org.apache.groovy.contracts.util.AnnotationUtils

Checks whether the given ClassNode is annotated with an annotations of the given package or full annotatedNode name.

hasDefaultClassInvariant() - Method in class org.apache.groovy.contracts.domain.Contract

hashCode() - Method in class org.apache.groovy.contracts.generation.ContractExecutionTracker.ContractExecution

hasMetaAnnotations(AnnotatedNode, String) - Static method in class org.apache.groovy.contracts.util.AnnotationUtils

Loads all annotation nodes of the given AnnotatedNode instance which are marked with the annotation metaAnnotationClassName.

hasViolations() - Method in class org.apache.groovy.contracts.ViolationTracker

I

init() - Static method in class org.apache.groovy.contracts.ViolationTracker

init(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.ConfigurationSetup

Adds an instance field which allows to control whether GContract assertions are enabled or not.

injectClassInvariant(ClassNode, ClassInvariant) - Method in class org.apache.groovy.contracts.ast.visitor.DomainModelInjectionVisitor

injectPostcondition(MethodNode, Postcondition) - Method in class org.apache.groovy.contracts.ast.visitor.DomainModelInjectionVisitor

injectPrecondition(MethodNode, Precondition) - Method in class org.apache.groovy.contracts.ast.visitor.DomainModelInjectionVisitor

injectResultVariableReturnStatementAndAssertionCallStatement(BlockStatement, ClassNode, ReturnStatement, BlockStatement) - Static method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility

INSTANCE - Static variable in class org.apache.groovy.contracts.ViolationTracker

Invariant - Annotation Type in groovy.contracts

Represents a class-invariant.

INVARIANT_CLOSURE_PREFIX - Static variable in class org.apache.groovy.contracts.generation.BaseGenerator

isClassInvariantCandidate(ClassNode, MethodNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Decides whether the given method is a candidate for class invariants.

isClassInvariantCandidate(PropertyNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Decides whether the given propertyNode is a candidate for class invariant injection.

isClassInvariantsEnabled() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

isConstructorAssertionsEnabled() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

isContractsCandidate(ClassNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Checks whether the given ClassNode is a candidate for applying contracts.

isFoundContractElement() - Method in class org.apache.groovy.contracts.ast.visitor.ContractElementVisitor

isInterfaceContractsCandidate(ClassNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Checks whether the given ClassNode is a candidate for applying interface contracts.

isPartOfConstructor() - Method in class org.apache.groovy.contracts.domain.Postcondition

isPostconditionCandidate(ClassNode, MethodNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Decides whether the given method is a candidate for a post-condition.

isPostconditionsEnabled() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

isPreconditionCandidate(ClassNode, MethodNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Decides whether the given method is a candidate for a pre-condition.

isPreconditionsEnabled() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

isPreOrPostconditionCandidate(ClassNode, MethodNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Decides whether the given method is a candidate for a pre- or postcondition.

isRuntimeClass(ClassNode) - Static method in class org.apache.groovy.contracts.generation.CandidateChecks

Checks whether the given ClassNode is part of the Groovy/Java runtime.

isTrue(boolean) - Static method in class org.apache.groovy.contracts.util.Validate

iterator() - Method in class org.apache.groovy.contracts.domain.AssertionMap

iterator() - Method in class org.apache.groovy.contracts.util.LifecycleImplementationLoader

J

join(MethodNode, T) - Method in class org.apache.groovy.contracts.domain.AssertionMap

L

last() - Method in class org.apache.groovy.contracts.ViolationTracker

Lifecycle - Interface in org.apache.groovy.contracts.common.spi

Specifies life-cycle hook-ins for applying AST transformation logic before and after the annotation processors have been run.

LifecycleAfterTransformationVisitor - Class in org.apache.groovy.contracts.ast.visitor

AST transformation visitor which is triggered after applying AnnotationProcessor related transformations.

LifecycleAfterTransformationVisitor(SourceUnit, ReaderSource, ProcessingContextInformation) - Constructor for class org.apache.groovy.contracts.ast.visitor.LifecycleAfterTransformationVisitor

LifecycleBeforeTransformationVisitor - Class in org.apache.groovy.contracts.ast.visitor

AST transformation visitor which is triggered before applying AnnotationProcessor related transformations.

LifecycleBeforeTransformationVisitor(SourceUnit, ReaderSource, ProcessingContextInformation) - Constructor for class org.apache.groovy.contracts.ast.visitor.LifecycleBeforeTransformationVisitor

LifecycleImplementationLoader<S> - Class in org.apache.groovy.contracts.util

Finds and loads implementation classes of interface Lifecycle.

load(Class<S>, ClassLoader) - Static method in class org.apache.groovy.contracts.util.LifecycleImplementationLoader

Creates a new Lifecycle for the given type and class loader.

M

META_DATA_ORIGINAL_TRY_CATCH_BLOCK - Static variable in class org.apache.groovy.contracts.ast.visitor.AnnotationClosureVisitor

META_DATA_USE_EXECUTION_TRACKER - Static variable in class org.apache.groovy.contracts.ast.visitor.AnnotationClosureVisitor

META_DATA_USE_INLINE_MODE - Static variable in class org.apache.groovy.contracts.generation.BaseGenerator

N

notNull(Object) - Static method in class org.apache.groovy.contracts.util.Validate

O

OLD_VARIABLES_METHOD - Static variable in class org.apache.groovy.contracts.generation.OldVariableGenerationUtility

OldVariableGenerationUtility - Class in org.apache.groovy.contracts.generation

Central place where code generation for the old closure variable takes place.

OldVariableGenerationUtility() - Constructor for class org.apache.groovy.contracts.generation.OldVariableGenerationUtility

or(MethodNode, T) - Method in class org.apache.groovy.contracts.domain.AssertionMap

or(T) - Method in class org.apache.groovy.contracts.domain.Assertion

org.apache.groovy.contracts - package org.apache.groovy.contracts

org.apache.groovy.contracts.annotations.meta - package org.apache.groovy.contracts.annotations.meta

org.apache.groovy.contracts.ast - package org.apache.groovy.contracts.ast

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

org.apache.groovy.contracts.classgen.asm - package org.apache.groovy.contracts.classgen.asm

org.apache.groovy.contracts.common.base - package org.apache.groovy.contracts.common.base

org.apache.groovy.contracts.common.impl - package org.apache.groovy.contracts.common.impl

org.apache.groovy.contracts.common.impl.lc - package org.apache.groovy.contracts.common.impl.lc

org.apache.groovy.contracts.common.spi - package org.apache.groovy.contracts.common.spi

org.apache.groovy.contracts.domain - package org.apache.groovy.contracts.domain

org.apache.groovy.contracts.generation - package org.apache.groovy.contracts.generation

org.apache.groovy.contracts.util - package org.apache.groovy.contracts.util

originalBlockStatement() - Method in class org.apache.groovy.contracts.domain.Assertion

P

PACKAGE_POSTFIX - Static variable in class org.apache.groovy.contracts.generation.Configurator

PACKAGE_PREFIX - Static variable in class org.apache.groovy.contracts.generation.Configurator

Postcondition - Class in org.apache.groovy.contracts.domain

A post-condition assertion.

Postcondition - Annotation Type in org.apache.groovy.contracts.annotations.meta

Indicates that annotations being marked as @Postcondition are to be treated as post-condition modifying annotations.

Postcondition() - Constructor for class org.apache.groovy.contracts.domain.Postcondition

Postcondition(BlockStatement, BooleanExpression, boolean) - Constructor for class org.apache.groovy.contracts.domain.Postcondition

PostconditionGenerator - Class in org.apache.groovy.contracts.generation

Code generator for postconditions.

PostconditionGenerator(ReaderSource) - Constructor for class org.apache.groovy.contracts.generation.PostconditionGenerator

PostconditionLifecycle - Class in org.apache.groovy.contracts.common.impl.lc

Internal Lifecycle implementation for post-conditions.

PostconditionLifecycle() - Constructor for class org.apache.groovy.contracts.common.impl.lc.PostconditionLifecycle

postconditions() - Method in class org.apache.groovy.contracts.domain.Contract

PostconditionViolation - Error in org.apache.groovy.contracts

Thrown whenever a postcondition violation occurs.

PostconditionViolation() - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(boolean) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(char) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(double) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(float) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(int) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(long) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

PostconditionViolation(Object) - Constructor for error org.apache.groovy.contracts.PostconditionViolation

Precondition - Class in org.apache.groovy.contracts.domain

A pre-condition assertion.

Precondition - Annotation Type in org.apache.groovy.contracts.annotations.meta

Indicates that annotations being marked as @Precondition are to be treated as pre-condition modifying annotations.

Precondition() - Constructor for class org.apache.groovy.contracts.domain.Precondition

Precondition(BlockStatement, BooleanExpression) - Constructor for class org.apache.groovy.contracts.domain.Precondition

PreconditionGenerator - Class in org.apache.groovy.contracts.generation

Code generator for preconditions.

PreconditionGenerator(ReaderSource) - Constructor for class org.apache.groovy.contracts.generation.PreconditionGenerator

PreconditionLifecycle - Class in org.apache.groovy.contracts.common.impl.lc

Internal Lifecycle implementation for pre-conditions.

PreconditionLifecycle() - Constructor for class org.apache.groovy.contracts.common.impl.lc.PreconditionLifecycle

preconditions() - Method in class org.apache.groovy.contracts.domain.Contract

PreconditionViolation - Error in org.apache.groovy.contracts

Thrown whenever a precondition violation occurs.

PreconditionViolation() - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(boolean) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(char) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(double) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(float) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(int) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(long) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

PreconditionViolation(Object) - Constructor for error org.apache.groovy.contracts.PreconditionViolation

process(ProcessingContextInformation, Contract, ClassNode, MethodNode, BlockStatement, BooleanExpression) - Method in class org.apache.groovy.contracts.common.impl.EnsuresAnnotationProcessor

process(ProcessingContextInformation, Contract, ClassNode, MethodNode, BlockStatement, BooleanExpression) - Method in class org.apache.groovy.contracts.common.impl.RequiresAnnotationProcessor

process(ProcessingContextInformation, Contract, ClassNode, MethodNode, BlockStatement, BooleanExpression) - Method in class org.apache.groovy.contracts.common.spi.AnnotationProcessor

process(ProcessingContextInformation, Contract, ClassNode, BlockStatement, BooleanExpression) - Method in class org.apache.groovy.contracts.common.impl.ClassInvariantAnnotationProcessor

process(ProcessingContextInformation, Contract, ClassNode, BlockStatement, BooleanExpression) - Method in class org.apache.groovy.contracts.common.spi.AnnotationProcessor

PROCESSED - Static variable in interface org.apache.groovy.contracts.ast.visitor.ASTNodeMetaData

ProcessingContextInformation - Class in org.apache.groovy.contracts.common.spi

Holds all context-specific information which is needed during the transformation phase of a single Contract and its related ClassNode.

ProcessingContextInformation(ClassNode, SourceUnit, ReaderSource) - Constructor for class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

put(String, Object) - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

R

readerSource() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

reload() - Method in class org.apache.groovy.contracts.util.LifecycleImplementationLoader

renew(BooleanExpression) - Method in class org.apache.groovy.contracts.domain.Assertion

Requires - Annotation Type in groovy.contracts

Represents a method precondition.

RequiresAnnotationProcessor - Class in org.apache.groovy.contracts.common.impl

Internal AnnotationProcessor implementation for pre-conditions.

RequiresAnnotationProcessor() - Constructor for class org.apache.groovy.contracts.common.impl.RequiresAnnotationProcessor

rethrowFirst() - Static method in class org.apache.groovy.contracts.ViolationTracker

rethrowLast() - Static method in class org.apache.groovy.contracts.ViolationTracker

ReturnStatementVisitor() - Constructor for class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.ReturnStatementVisitor

S

setClassInvariant(ClassInvariant) - Method in class org.apache.groovy.contracts.domain.Contract

setConstructorAssertionsEnabled(boolean) - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

size() - Method in class org.apache.groovy.contracts.domain.AssertionMap

source - Variable in class org.apache.groovy.contracts.ast.visitor.BaseVisitor

source - Variable in class org.apache.groovy.contracts.generation.BaseGenerator

sourceUnit - Variable in class org.apache.groovy.contracts.ast.visitor.BaseVisitor

sourceUnit() - Method in class org.apache.groovy.contracts.common.spi.ProcessingContextInformation

T

track(String, String, String, boolean) - Static method in class org.apache.groovy.contracts.generation.ContractExecutionTracker

track(AssertionViolation) - Method in class org.apache.groovy.contracts.ViolationTracker

TryCatchBlockGenerator - Class in org.apache.groovy.contracts.generation

Creates a try-catch block around a given AssertStatement and catches a PowerAssertionError to reuse the generated visual output.

TryCatchBlockGenerator() - Constructor for class org.apache.groovy.contracts.generation.TryCatchBlockGenerator

V

Validate - Class in org.apache.groovy.contracts.util

Internal utility class for in-code assertion checks.

Validate() - Constructor for class org.apache.groovy.contracts.util.Validate

value() - Element in annotation type groovy.contracts.Ensures

value() - Element in annotation type groovy.contracts.Invariant

value() - Element in annotation type groovy.contracts.Requires

value() - Element in annotation type org.apache.groovy.contracts.annotations.meta.AnnotationProcessorImplementation

violationsOccurred() - Static method in class org.apache.groovy.contracts.ViolationTracker

ViolationTracker - Class in org.apache.groovy.contracts

A violation tracker is used to keep a list of pre-, post-condition or class-invariant violations in chronological order.

ViolationTracker() - Constructor for class org.apache.groovy.contracts.ViolationTracker

visit(ASTNode[], SourceUnit) - Method in class org.apache.groovy.contracts.ast.ClosureExpressionEvaluationASTTransformation

ASTTransformation.visit(org.codehaus.groovy.ast.ASTNode[], org.codehaus.groovy.control.SourceUnit)

visit(ASTNode[], SourceUnit) - Method in class org.apache.groovy.contracts.ast.GContractsASTTransformation

ASTTransformation.visit(org.codehaus.groovy.ast.ASTNode[], org.codehaus.groovy.control.SourceUnit)

visitAnnotations(AnnotatedNode) - Method in class org.apache.groovy.contracts.ast.visitor.AnnotationContractParameterVisitor

visitBlockStatement(BlockStatement) - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.AddAssertionCallStatementToReturnStatementVisitor

visitBlockStatement(BlockStatement) - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.AddResultReturnStatementVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.AnnotationClosureVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.AnnotationContractParameterVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.AnnotationProcessorVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.ContractElementVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.DomainModelInjectionVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.DynamicSetterInjectionVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.LifecycleAfterTransformationVisitor

visitClass(ClassNode) - Method in class org.apache.groovy.contracts.ast.visitor.LifecycleBeforeTransformationVisitor

visitClosureExpression(ClosureExpression) - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.ReturnStatementVisitor

visitConstructorOrMethod(MethodNode, boolean) - Method in class org.apache.groovy.contracts.ast.visitor.AnnotationClosureVisitor

visitConstructorOrMethod(MethodNode, boolean) - Method in class org.apache.groovy.contracts.ast.visitor.ContractElementVisitor

visitMethod(MethodNode) - Method in class org.apache.groovy.contracts.ast.visitor.AnnotationContractParameterVisitor

visitProperty(PropertyNode) - Method in class org.apache.groovy.contracts.ast.visitor.DynamicSetterInjectionVisitor

visitReturnStatement(ReturnStatement) - Method in class org.apache.groovy.contracts.generation.AssertStatementCreationUtility.ReturnStatementVisitor

W

wrapAssertionBooleanExpression(ClassNode, MethodNode, BooleanExpression, String) - Method in class org.apache.groovy.contracts.generation.BaseGenerator

A B C D E F G H I J L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form