Record Class MethodContext

java.lang.Object

java.lang.Record

io.micronaut.sourcegen.bytecode.MethodContext

Record Components:

objectDef - The current object definition

methodDef - The current method definition.

locals - The locals

lambdaMethods - Lambda methods created by this method

isLambda - Whether this method is a lambda

yieldTargets - The switch yield cases being written, innermost last

openGaps - The gaps opened by the returns and yields being written, innermost last

@Internal
public record MethodContext(@Nullable ObjectDef objectDef, MethodDef methodDef, Map<String, MethodContext.LocalData> locals, List<MethodDef> lambdaMethods, boolean isLambda, Deque<MethodContext.YieldTarget> yieldTargets, List<MethodContext.Gap> openGaps)
extends Record

The statement context.

Since:

1.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MethodContext.Gap	The code a return or a yield writes on its way out of a try or a synchronized statement: from the copy of the finally block, or from past the release of the monitor, to past the instruction that leaves.
static final record	MethodContext.LocalData	The local data.
static final record	MethodContext.YieldTarget	A switch yield case being written.

Constructor Summary

Constructors

Constructor	Description
MethodContext(@Nullable ObjectDef objectDef, MethodDef methodDef, boolean isLambda)
MethodContext(@Nullable ObjectDef objectDef, MethodDef methodDef, Map<String, MethodContext.LocalData> locals, List<MethodDef> lambdaMethods, boolean isLambda)
MethodContext(@Nullable ObjectDef objectDef, MethodDef methodDef, Map<String, MethodContext.LocalData> locals, List<MethodDef> lambdaMethods, boolean isLambda, Deque<MethodContext.YieldTarget> yieldTargets, List<MethodContext.Gap> openGaps)	Creates an instance of a MethodContext record class.

Method Summary

Modifier and Type	Method	Description
void	closeGaps(org.objectweb.asm.commons.GeneratorAdapter generatorAdapter, int from)	Closes the gaps opened by a return or a yield, once it has written the instruction that leaves.
@Nullable MethodContext.YieldTarget	currentYieldTarget()	The switch yield case a return statement contributes its value to, instead of returning from the method.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isLambda()	Returns the value of the isLambda record component.
List<MethodDef>	lambdaMethods()	Returns the value of the lambdaMethods record component.
Map<String, MethodContext.LocalData>	locals()	Returns the value of the locals record component.
MethodDef	methodDef()	Returns the value of the methodDef record component.
@Nullable ObjectDef	objectDef()	Returns the value of the objectDef record component.
MethodContext.Gap	openGap(org.objectweb.asm.commons.GeneratorAdapter generatorAdapter)	Opens a gap at the current position, where a return or a yield writes the cleanup of a statement it leaves.
List<MethodContext.Gap>	openGaps()	Returns the value of the openGaps record component.
final String	toString()	Returns a string representation of this record class.
Deque<MethodContext.YieldTarget>	yieldTargets()	Returns the value of the yieldTargets record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MethodContext

public MethodContext(@Nullable ObjectDef objectDef,
 MethodDef methodDef,
 Map<String, MethodContext.LocalData> locals,
 List<MethodDef> lambdaMethods,
 boolean isLambda)

MethodContext

public MethodContext(@Nullable ObjectDef objectDef,
 MethodDef methodDef,
 boolean isLambda)

MethodContext

public MethodContext(@Nullable ObjectDef objectDef,
 MethodDef methodDef,
 Map<String, MethodContext.LocalData> locals,
 List<MethodDef> lambdaMethods,
 boolean isLambda,
 Deque<MethodContext.YieldTarget> yieldTargets,
 List<MethodContext.Gap> openGaps)

Creates an instance of a MethodContext record class.

Parameters:

objectDef - the value for the objectDef record component

methodDef - the value for the methodDef record component

locals - the value for the locals record component

lambdaMethods - the value for the lambdaMethods record component

isLambda - the value for the isLambda record component

yieldTargets - the value for the yieldTargets record component

openGaps - the value for the openGaps record component

Method Details

currentYieldTarget

public @Nullable MethodContext.YieldTarget currentYieldTarget()

The switch yield case a return statement contributes its value to, instead of returning from the method.

Returns:

The innermost yield case being written, or null when a return is a method return

openGap

public MethodContext.Gap openGap(org.objectweb.asm.commons.GeneratorAdapter generatorAdapter)

Opens a gap at the current position, where a return or a yield writes the cleanup of a statement it leaves. The return or the yield closes the gap past the instruction that leaves.

Parameters:

generatorAdapter - The adapter

Returns:

The gap

closeGaps

public void closeGaps(org.objectweb.asm.commons.GeneratorAdapter generatorAdapter,
 int from)

Closes the gaps opened by a return or a yield, once it has written the instruction that leaves.

Parameters:

generatorAdapter - The adapter

from - The number of gaps that were open before the return or the yield

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

objectDef

public @Nullable ObjectDef objectDef()

Returns the value of the objectDef record component.

Returns:

the value of the objectDef record component

methodDef

public MethodDef methodDef()

Returns the value of the methodDef record component.

Returns:

the value of the methodDef record component

locals

public Map<String, MethodContext.LocalData> locals()

Returns the value of the locals record component.

Returns:

the value of the locals record component

lambdaMethods

public List<MethodDef> lambdaMethods()

Returns the value of the lambdaMethods record component.

Returns:

the value of the lambdaMethods record component

isLambda

public boolean isLambda()

Returns the value of the isLambda record component.

Returns:

the value of the isLambda record component

yieldTargets

public Deque<MethodContext.YieldTarget> yieldTargets()

Returns the value of the yieldTargets record component.

Returns:

the value of the yieldTargets record component

openGaps

public List<MethodContext.Gap> openGaps()

Returns the value of the openGaps record component.

Returns:

the value of the openGaps record component