Package io.papermc.asm.rules.method.rewrite

Record Class SimpleRewrite

java.lang.Object

java.lang.Record

io.papermc.asm.rules.method.rewrite.SimpleRewrite

Record Components:

opcode - the replaced opcode

owner - the replaced owner

name - the replaced name

descriptor - the replaced descriptor

isInterface - if the replaced method is an interface method

isInvokeDynamic - if the replaced method is an invokedynamic

generatorInfo - info for generating the method (optional)

All Implemented Interfaces:

MethodRewrite<GeneratedMethodHolder.MethodCallData>

public record SimpleRewrite(int opcode, ClassDesc owner, String name, MethodTypeDesc descriptor, boolean isInterface, boolean isInvokeDynamic, @Nullable MethodRewrite.GeneratorInfo<GeneratedMethodHolder.MethodCallData> generatorInfo, @Nullable Consumer<Object[]> handleExtras)
extends Record
implements MethodRewrite<GeneratedMethodHolder.MethodCallData>

Holds the structure of the rewritten method that replaces a matching method found in the bytecode. This is for non-constructors. For constructors, use ConstructorRewrite.

Nested Class Summary

Nested classes/interfaces inherited from interface io.papermc.asm.rules.method.rewrite.MethodRewrite

MethodRewrite.GeneratorInfo<D extends GeneratedMethodHolder.CallData>, MethodRewrite.MethodGenerator

Field Summary

Fields inherited from interface io.papermc.asm.rules.method.rewrite.MethodRewrite

BOOTSTRAP_HANDLE_IDX, DYNAMIC_TYPE_IDX, GENERATED_PREFIX

Constructor Summary

Constructors

Constructor	Description
SimpleRewrite(int opcode, ClassDesc owner, String name, MethodTypeDesc descriptor, boolean isInterface, boolean isInvokeDynamic)
SimpleRewrite(int opcode, ClassDesc owner, String name, MethodTypeDesc descriptor, boolean isInterface, boolean isInvokeDynamic, @Nullable MethodRewrite.GeneratorInfo<GeneratedMethodHolder.MethodCallData> generatorInfo, @Nullable Consumer<Object[]> handleExtras)	Creates an instance of a SimpleRewrite record class.

Method Summary

Modifier and Type	Method	Description
void	apply(MethodVisitor delegate, MethodNode context)	Called to apply the rewrite when a matching invoke non-dynamic instruction is found.
void	applyToBootstrapArguments(Object[] arguments)	Called to apply the rewrite to a matching invokedynamic instruction is found.
@Nullable MethodRewrite.MethodGenerator	createMethodGenerator()	Creates a MethodRewrite.MethodGenerator for this rewrite.
MethodTypeDesc	descriptor()	Returns the value of the descriptor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable MethodRewrite.GeneratorInfo<GeneratedMethodHolder.MethodCallData>	generatorInfo()	Returns the value of the generatorInfo record component.
@Nullable Consumer<Object[]>	handleExtras()	Returns the value of the handleExtras record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isInterface()	Returns the value of the isInterface record component.
boolean	isInvokeDynamic()	Returns the value of the isInvokeDynamic record component.
String	name()	Returns the value of the name record component.
int	opcode()	Returns the value of the opcode record component.
ClassDesc	owner()	Returns the value of the owner record component.
final String	toString()	Returns a string representation of this record class.
MethodRewrite<GeneratedMethodHolder.MethodCallData>	withGeneratorInfo(GeneratedMethodHolder holder, GeneratedMethodHolder.MethodCallData original)	Creates a new MethodRewrite with the given generator info.
MethodRewrite<GeneratedMethodHolder.MethodCallData>	withHandleExtras(Consumer<Object[]> extras)	Creates a new MethodRewrite with the given "extras" handler.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleRewrite

public SimpleRewrite(int opcode,
 ClassDesc owner,
 String name,
 MethodTypeDesc descriptor,
 boolean isInterface,
 boolean isInvokeDynamic)

SimpleRewrite

public SimpleRewrite(int opcode,
 ClassDesc owner,
 String name,
 MethodTypeDesc descriptor,
 boolean isInterface,
 boolean isInvokeDynamic,
 @Nullable MethodRewrite.GeneratorInfo<GeneratedMethodHolder.MethodCallData> generatorInfo,
 @Nullable Consumer<Object[]> handleExtras)

Creates an instance of a SimpleRewrite record class.

Parameters:

opcode - the value for the opcode record component

owner - the value for the owner record component

name - the value for the name record component

descriptor - the value for the descriptor record component

isInterface - the value for the isInterface record component

isInvokeDynamic - the value for the isInvokeDynamic record component

generatorInfo - the value for the generatorInfo record component

handleExtras - the value for the handleExtras record component

Method Details

apply

public void apply(MethodVisitor delegate,
 MethodNode context)

Description copied from interface: MethodRewrite

Called to apply the rewrite when a matching invoke non-dynamic instruction is found.

Specified by:

apply in interface MethodRewrite<GeneratedMethodHolder.MethodCallData>

Parameters:

delegate - the visitor to apply the change to

context - the surrounding context of the method's data including instructions

applyToBootstrapArguments

public void applyToBootstrapArguments(Object[] arguments)

Description copied from interface: MethodRewrite

Called to apply the rewrite to a matching invokedynamic instruction is found.

Specified by:

applyToBootstrapArguments in interface MethodRewrite<GeneratedMethodHolder.MethodCallData>

Parameters:

arguments - the bootstrap arguments MethodVisitor.visitInvokeDynamicInsn(String, String, Handle, Object...)

withGeneratorInfo

public MethodRewrite<GeneratedMethodHolder.MethodCallData> withGeneratorInfo(GeneratedMethodHolder holder,
 GeneratedMethodHolder.MethodCallData original)

Description copied from interface: MethodRewrite

Creates a new MethodRewrite with the given generator info.

Specified by:

withGeneratorInfo in interface MethodRewrite<GeneratedMethodHolder.MethodCallData>

Parameters:

holder - the generator holder

original - the original call data

Returns:

the new rewrite

withHandleExtras

public MethodRewrite<GeneratedMethodHolder.MethodCallData> withHandleExtras(Consumer<Object[]> extras)

Description copied from interface: MethodRewrite

Creates a new MethodRewrite with the given "extras" handler. This is when extra changes are required for invokedynamic instructions.

Specified by:

withHandleExtras in interface MethodRewrite<GeneratedMethodHolder.MethodCallData>

Parameters:

extras - the extras handler

Returns:

the new rewrite (or the same if not supported on the rewrite type)

createMethodGenerator

public @Nullable MethodRewrite.MethodGenerator createMethodGenerator()

Description copied from interface: MethodRewrite

Creates a MethodRewrite.MethodGenerator for this rewrite.

Specified by:

createMethodGenerator in interface MethodRewrite<GeneratedMethodHolder.MethodCallData>

Returns:

a method generator, or null if this rewrite doesn't have one

See Also:

• MethodRewrite.withGeneratorInfo(GeneratedMethodHolder, GeneratedMethodHolder.CallData)

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 '=='.

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.

opcode

public int opcode()

Returns the value of the opcode record component.

Returns:

the value of the opcode record component

owner

public ClassDesc owner()

Returns the value of the owner record component.

Returns:

the value of the owner record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

descriptor

public MethodTypeDesc descriptor()

Returns the value of the descriptor record component.

Returns:

the value of the descriptor record component

isInterface

public boolean isInterface()

Returns the value of the isInterface record component.

Returns:

the value of the isInterface record component

isInvokeDynamic

public boolean isInvokeDynamic()

Returns the value of the isInvokeDynamic record component.

Returns:

the value of the isInvokeDynamic record component

generatorInfo

public @Nullable MethodRewrite.GeneratorInfo<GeneratedMethodHolder.MethodCallData> generatorInfo()

Returns the value of the generatorInfo record component.

Returns:

the value of the generatorInfo record component

handleExtras

public @Nullable Consumer<Object[]> handleExtras()

Returns the value of the handleExtras record component.

Returns:

the value of the handleExtras record component