Top Description Inners Fields Constructors Methods

org.codehaus.groovy.classgen

public Class ReturnAdder

Class Inheritance

extends Object

java.lang.Object
org.codehaus.groovy.classgen.ReturnAdder

Imports

org.codehaus.groovy.ast.MethodNode, .VariableScope, org.codehaus.groovy.ast.expr.Expression, org.codehaus.groovy.ast.stmt.BlockStatement, .BreakStatement, .CaseStatement, .CatchStatement, .EmptyStatement, .ExpressionStatement, .IfStatement, .ReturnStatement, .Statement, .SwitchStatement, .SynchronizedStatement, .ThrowStatement, .TryCatchStatement, java.util.ArrayList, .Iterator, .List, .Objects

Utility class to add return statements.

Extracted from Verifier as it can be useful for some AST transformations.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	ReturnAdder.ReturnStatementListener

Field Summary

Modifier and Type	Field and Description
private static final ReturnAdder.ReturnStatementListener	DEFAULT_LISTENER
private final boolean	doAdd If set to 'true', then returns are effectively added.
private final ReturnAdder.ReturnStatementListener	listener

Constructor Summary

Access	Constructor and Description
public	ReturnAdder()
public	ReturnAdder(final ReturnAdder.ReturnStatementListener listener)

Method Summary

Modifier and Type	Method and Description
public static void	addReturnIfNeeded(final MethodNode node) Deprecated Use `visitMethod(MethodNode)` instead.
private Statement	addReturnsIfNeeded(final Statement statement, final VariableScope scope)
private Statement	adjustSwitchCaseCode(final Statement statement, final VariableScope scope, final boolean lastCase)
private static boolean	returns(final Statement statement)
public void	visitMethod(final MethodNode node) Adds return statements to given method whenever an implicit return is detected.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_LISTENER	back to summary
private static final ReturnAdder.ReturnStatementListener DEFAULT_LISTENER

doAdd	back to summary
private final boolean doAdd If set to 'true', then returns are effectively added. This is useful whenever you just want to check what returns are produced without eventually adding them.

listener	back to summary
private final ReturnAdder.ReturnStatementListener listener

Constructor Detail

ReturnAdder	back to summary
public ReturnAdder()

ReturnAdder	back to summary
public ReturnAdder(final ReturnAdder.ReturnStatementListener listener)

Method Detail

addReturnIfNeeded	back to summary
public static void addReturnIfNeeded(final MethodNode node) Deprecated Use `visitMethod(MethodNode)` instead. Annotations @Deprecated

addReturnsIfNeeded	back to summary
private Statement addReturnsIfNeeded(final Statement statement, final VariableScope scope)

adjustSwitchCaseCode	back to summary
private Statement adjustSwitchCaseCode(final Statement statement, final VariableScope scope, final boolean lastCase)

returns	back to summary
private static boolean returns(final Statement statement)

visitMethod	back to summary
public void visitMethod(final MethodNode node) Adds return statements to given method whenever an implicit return is detected.

org.codehaus.groovy.classgen back to summary

public Interface ReturnAdder.ReturnStatementListener

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public void	returnStatementAdded(ReturnStatement returnStatement) Implement this method in order to be notified whenever a return statement is generated.

Method Detail

returnStatementAdded	back to summary
public void returnStatementAdded(ReturnStatement returnStatement) Implement this method in order to be notified whenever a return statement is generated.