Package net.neoforged.neoforge.coremods

Class ReplaceFieldWithGetterAccess

java.lang.Object

net.neoforged.neoforge.coremods.ReplaceFieldWithGetterAccess

All Implemented Interfaces:

ITransformer<org.objectweb.asm.tree.ClassNode>

public class ReplaceFieldWithGetterAccess
extends Object
implements ITransformer<org.objectweb.asm.tree.ClassNode>

Replaces direct field access in a class with access to the getter.

The field specified by fieldName must be private and non-static. The method-call the field-access is redirected to does not take any parameters and returns an object of the same type as the field. If no methodName is passed, any method matching the described signature will be used as callable method.

Nested Class Summary

Nested classes/interfaces inherited from interface cpw.mods.modlauncher.api.ITransformer

ITransformer.Target<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	fieldToMethod
private final Set<ITransformer.Target<org.objectweb.asm.tree.ClassNode>>	targets

Fields inherited from interface cpw.mods.modlauncher.api.ITransformer

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor	Description
ReplaceFieldWithGetterAccess(String className, Map<String,String> fieldToMethod)

Method Summary

Modifier and Type	Method	Description
TransformerVoteResult	castVote(ITransformerVotingContext context)	Return the TransformerVoteResult for this transformer.
TargetType<org.objectweb.asm.tree.ClassNode>	getTargetType()
private static void	redirectFieldToMethod(org.objectweb.asm.tree.ClassNode classNode, String fieldName, @Nullable String methodName)
Set<ITransformer.Target<org.objectweb.asm.tree.ClassNode>>	targets()	Return a set of ITransformer.Target identifying which elements this transformer wishes to try and apply to.
org.objectweb.asm.tree.ClassNode	transform(org.objectweb.asm.tree.ClassNode input, ITransformerVotingContext context)	Transform the input to the ITransformer's desire.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cpw.mods.modlauncher.api.ITransformer

labels

Field Details

fieldToMethod

private final Map<String,String> fieldToMethod

targets

private final Set<ITransformer.Target<org.objectweb.asm.tree.ClassNode>> targets

Constructor Details

ReplaceFieldWithGetterAccess

public ReplaceFieldWithGetterAccess(String className,
 Map<String,String> fieldToMethod)

Method Details

getTargetType

public TargetType<org.objectweb.asm.tree.ClassNode> getTargetType()

Specified by:

getTargetType in interface ITransformer<org.objectweb.asm.tree.ClassNode>

targets

public Set<ITransformer.Target<org.objectweb.asm.tree.ClassNode>> targets()

Description copied from interface: ITransformer

Return a set of ITransformer.Target identifying which elements this transformer wishes to try and apply to. The ITransformer.getTargetType() must match the T variable for the transformer as documented in TargetType, other combinations will be rejected.

Specified by:

targets in interface ITransformer<org.objectweb.asm.tree.ClassNode>

Returns:

The set of targets this transformer wishes to apply to

transform

public org.objectweb.asm.tree.ClassNode transform(org.objectweb.asm.tree.ClassNode input,
 ITransformerVotingContext context)

Description copied from interface: ITransformer

Transform the input to the ITransformer's desire. The context from the last vote is provided as well.

Specified by:

transform in interface ITransformer<org.objectweb.asm.tree.ClassNode>

Parameters:

input - The ASM input node, which can be mutated directly

context - The voting context

Returns:

An ASM node of the same type as that supplied. It will be used for subsequent rounds of voting.

castVote

public TransformerVoteResult castVote(ITransformerVotingContext context)

Description copied from interface: ITransformer

Return the TransformerVoteResult for this transformer. The transformer should evaluate whether or not is is a candidate to apply during the round of voting in progress, represented by the context parameter. How the vote works:

• If the transformer wishes to be a candidate, it should return TransformerVoteResult.YES.
• If the transformer wishes to exit the voting (the transformer has already has its intended change applied, for example), it should return TransformerVoteResult.NO
• If the transformer wishes to wait for future rounds of voting it should return TransformerVoteResult.DEFER. Note that if there is no YES candidate, but DEFER candidates remain, this is a DEFERRAL stalemate and the game will crash.
• If the transformer wishes to crash the game, it should return TransformerVoteResult.REJECT. This is extremely frowned upon, and should not be used except in extreme circumstances. If an incompatibility is present, it should detect and handle it in the ITransformationService.onLoad(cpw.mods.modlauncher.api.IEnvironment, java.util.Set<java.lang.String>)

After all votes from candidate transformers are collected, the NOs are removed from the current set of voters, one from the set of YES voters is selected and it's ITransformer.transform(Object, ITransformerVotingContext) method called. It is then removed from the set of transformers and another round is performed.

Specified by:

castVote in interface ITransformer<org.objectweb.asm.tree.ClassNode>

Parameters:

context - The context of the vote

Returns:

A TransformerVoteResult indicating the desire of this transformer

redirectFieldToMethod

private static void redirectFieldToMethod(org.objectweb.asm.tree.ClassNode classNode,
 String fieldName,
 @Nullable
 @Nullable String methodName)