Package io.papermc.asm.rules.method.params

Record Class FuzzyParameterRewrite

java.lang.Object

java.lang.Record

io.papermc.asm.rules.method.params.FuzzyParameterRewrite

Record Components:

owners - the owners to target

existingType - the type to convert to

methodMatcher - the method matcher to use which targets the legacy param type

staticHandler - the method which will be used to convert the legacy type to the new type

All Implemented Interfaces:

GeneratedMethodHolder, GeneratedMethodSource<Set<Integer>>, StaticHandlerGeneratedMethodHolder, StaticHandlerGeneratedMethodHolder.Param, GeneratedStaticRewrite, TargetedTypeGeneratedStaticRewrite, TargetedTypeGeneratedStaticRewrite.Parameter, MethodRewriteRule, OwnableMethodRewriteRule, OwnableMethodRewriteRule.Filtered, StaticRewrite, OwnableRewriteRule, RewriteRule

public record FuzzyParameterRewrite(Set<ClassDesc> owners, ClassDesc existingType, TargetedMethodMatcher methodMatcher, Method staticHandler)
extends Record
implements TargetedTypeGeneratedStaticRewrite.Parameter, OwnableMethodRewriteRule.Filtered

Rewrites matching bytecode to a generated method. The generated method will accept Object params where the legacy type was found. This is what gives it its "fuzziness". The usefulness of this is when only *some* valid parameters need to be converted to a new type, and they don't share inheritance anymore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FuzzyParameterRewrite.Versioned

Nested classes/interfaces inherited from interface io.papermc.asm.rules.generate.GeneratedMethodHolder

GeneratedMethodHolder.CallData, GeneratedMethodHolder.ConstructorCallData, GeneratedMethodHolder.MethodCallData

Nested classes/interfaces inherited from interface io.papermc.asm.rules.generate.GeneratedMethodSource

GeneratedMethodSource.NoContext

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

OwnableMethodRewriteRule.Filtered

Nested classes/interfaces inherited from interface io.papermc.asm.rules.RewriteRule

RewriteRule.Chain, RewriteRule.ChainBuilder, RewriteRule.Delegate, RewriteRule.GeneratorAdapterFactory

Nested classes/interfaces inherited from interface io.papermc.asm.rules.generate.StaticHandlerGeneratedMethodHolder

StaticHandlerGeneratedMethodHolder.Param, StaticHandlerGeneratedMethodHolder.Return

Nested classes/interfaces inherited from interface io.papermc.asm.rules.method.generated.TargetedTypeGeneratedStaticRewrite

TargetedTypeGeneratedStaticRewrite.Parameter, TargetedTypeGeneratedStaticRewrite.Return

Field Summary

Fields inherited from interface io.papermc.asm.rules.method.MethodRewriteRule

LAMBDA_METAFACTORY_OWNER

Fields inherited from interface io.papermc.asm.rules.RewriteRule

EMPTY

Fields inherited from interface io.papermc.asm.rules.method.StaticRewrite

CONSTRUCTOR_METHOD_NAME

Constructor Summary

Constructors

Constructor	Description
FuzzyParameterRewrite(Set<ClassDesc> owners, ClassDesc existingType, TargetedMethodMatcher methodMatcher, Method staticHandler)	Creates an instance of a FuzzyParameterRewrite record class.

Method Summary

Modifier and Type	Method	Description
MethodRewrite<GeneratedMethodHolder.MethodCallData>	createRewrite(ClassProcessingContext context, MethodTypeDesc intermediateDescriptor, GeneratedMethodHolder.MethodCallData originalCallData)	Creates a rewrite for the given method call data.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ClassDesc	existingType()	Returns the value of the existingType record component.
final int	hashCode()	Returns a hash code value for this object.
TargetedMethodMatcher	methodMatcher()	Returns the value of the methodMatcher record component.
Set<ClassDesc>	owners()	Returns the value of the owners record component.
Method	staticHandler()	Returns the value of the staticHandler record component.
final String	toString()	Returns a string representation of this record class.
MethodTypeDesc	transformInvokedDescriptor(MethodTypeDesc original, Set<Integer> context)	Transforms the descriptor of the generated method to the descriptor of the method that will be called within the generated method.
MethodTypeDesc	transformToRedirectDescriptor(MethodTypeDesc intermediateDescriptor)	Transforms the intermediate descriptor to the final descriptor that will be used in the rewritten bytecode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.papermc.asm.rules.generate.GeneratedMethodHolder

createAdapter

Methods inherited from interface io.papermc.asm.rules.generate.GeneratedMethodSource

generateConstructor, generateMethod, generateReturnValue

Methods inherited from interface io.papermc.asm.rules.method.generated.GeneratedStaticRewrite

createConstructorRewrite, staticRedirectOwner

Methods inherited from interface io.papermc.asm.rules.method.MethodRewriteRule

createVisitor

Methods inherited from interface io.papermc.asm.rules.method.OwnableMethodRewriteRule.Filtered

shouldProcess

Methods inherited from interface io.papermc.asm.rules.OwnableRewriteRule

matchesOwner

Methods inherited from interface io.papermc.asm.rules.generate.StaticHandlerGeneratedMethodHolder.Param

createNewContext, generateParameters

Methods inherited from interface io.papermc.asm.rules.method.StaticRewrite

rewrite

Constructor Details

FuzzyParameterRewrite

public FuzzyParameterRewrite(Set<ClassDesc> owners,
 ClassDesc existingType,
 TargetedMethodMatcher methodMatcher,
 Method staticHandler)

Creates an instance of a FuzzyParameterRewrite record class.

Parameters:

owners - the value for the owners record component

existingType - the value for the existingType record component

methodMatcher - the value for the methodMatcher record component

staticHandler - the value for the staticHandler record component

Method Details

transformToRedirectDescriptor

public MethodTypeDesc transformToRedirectDescriptor(MethodTypeDesc intermediateDescriptor)

Description copied from interface: StaticRewrite

Transforms the intermediate descriptor to the final descriptor that will be used in the rewritten bytecode.

Intermediate means that it has been modified from the original accounting for the virtual/interface/static/constructor-ness of the method call.

Specified by:

transformToRedirectDescriptor in interface StaticRewrite

Parameters:

intermediateDescriptor - the intermediate descriptor

Returns:

the final descriptor to be used in the rewritten bytecode

transformInvokedDescriptor

public MethodTypeDesc transformInvokedDescriptor(MethodTypeDesc original,
 Set<Integer> context)

Description copied from interface: GeneratedMethodSource

Transforms the descriptor of the generated method to the descriptor of the method that will be called within the generated method. This should be the method that actually exists in source.

Specified by:

transformInvokedDescriptor in interface GeneratedMethodSource<Set<Integer>>

Specified by:

transformInvokedDescriptor in interface TargetedTypeGeneratedStaticRewrite.Parameter

Parameters:

original - the method descriptor of the generated method that the bytecode was redirected to

context - context for the generator

Returns:

the descriptor of the method that will be called inside the generated method

createRewrite

public MethodRewrite<GeneratedMethodHolder.MethodCallData> createRewrite(ClassProcessingContext context,
 MethodTypeDesc intermediateDescriptor,
 GeneratedMethodHolder.MethodCallData originalCallData)

Description copied from interface: StaticRewrite

Creates a rewrite for the given method call data.

Specified by:

createRewrite in interface GeneratedStaticRewrite

Specified by:

createRewrite in interface StaticRewrite

Parameters:

context - the context

intermediateDescriptor - the descriptor modified from the original to account for the method call type (interface, virtual, static, etc.)

originalCallData - the original method call data

Returns:

the rewrite

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

owners

public Set<ClassDesc> owners()

Returns the value of the owners record component.

Specified by:

owners in interface OwnableRewriteRule

Returns:

the value of the owners record component

existingType

public ClassDesc existingType()

Returns the value of the existingType record component.

Specified by:

existingType in interface TargetedTypeGeneratedStaticRewrite

Returns:

the value of the existingType record component

methodMatcher

public TargetedMethodMatcher methodMatcher()

Returns the value of the methodMatcher record component.

Specified by:

methodMatcher in interface OwnableMethodRewriteRule.Filtered

Specified by:

methodMatcher in interface TargetedTypeGeneratedStaticRewrite.Parameter

Returns:

the value of the methodMatcher record component

staticHandler

public Method staticHandler()

Returns the value of the staticHandler record component.

Specified by:

staticHandler in interface StaticHandlerGeneratedMethodHolder

Returns:

the value of the staticHandler record component