MixinTargetContext (Mixin 0.7.11.12 API)

java.lang.Object
- org.spongepowered.asm.mixin.transformer.MixinTargetContext

All Implemented Interfaces:

IMixinContext
```
public class MixinTargetContext
extends java.lang.Object
implements IMixinContext
```
This object keeps track of data for applying a mixin to a specific target class during a mixin application. This is a single-use object which acts as both a handle information we need when applying the mixin (such as the actual mixin ClassNode and the target ClassNode) and a gateway to context-sensitive operations such as re-targetting method and field accesses in the mixin to the appropriate members in the target class hierarchy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyInjections()` Apply injectors discovered in the `prepareInjections()` pass
`ClassInfo`	`findRealType(ClassInfo mixin)` Find the corresponding class type for the supplied mixin class in this mixin target's hierarchy
`java.util.List<org.spongepowered.asm.lib.tree.MethodNode>`	`generateAccessors()` Expand accessor methods mixed into the target class by populating the method bodies
`protected ClassInfo`	`getClassInfo()` Get the class info for this class
`java.lang.String`	`getClassName()` Get the mixin class name
`org.spongepowered.asm.lib.tree.ClassNode`	`getClassNode()` Get the mixin tree
`java.lang.String`	`getClassRef()` Get the internal class name
`java.lang.String`	`getDefaultInjectorGroup()` Get the defined injector group for injectors
`int`	`getDefaultRequiredInjections()` Get the defined value for the `Inject.require()` parameter on injectors defined in mixins in this configuration.
`MixinEnvironment`	`getEnvironment()` Get the environment of the owning mixin config
`Extensions`	`getExtensions()` Get the mixin transformer extension manager
`java.util.List<org.spongepowered.asm.lib.tree.FieldNode>`	`getFields()` Get fields to mixin
`InjectorGroupInfo.Map`	`getInjectorGroups()` Get the injector groups for this target
`java.util.Set<java.lang.String>`	`getInterfaces()` Get all interfaces for this mixin
`org.apache.logging.log4j.Level`	`getLoggingLevel()` Get the logging level for this mixin
`int`	`getMaxShiftByValue()` Get the max shift "by" value for the parent config
`java.util.List<org.spongepowered.asm.lib.tree.MethodNode>`	`getMethods()` Get methods to mixin
`int`	`getMinRequiredClassVersion()` Get the minimum required class version for this mixin
`IMixinInfo`	`getMixin()` Get the mixin info
`boolean`	`getOption(MixinEnvironment.Option option)` Retrieve the value of the specified `option` from the environment this mixin belongs to.
`int`	`getPriority()` Get the mixin priority
`IReferenceMapper`	`getReferenceMapper()` Get the reference mapper for this mixin
`java.util.Set<java.util.Map.Entry<org.spongepowered.asm.lib.tree.FieldNode,org.spongepowered.asm.mixin.transformer.ClassInfo.Field>>`	`getShadowFields()` Get shadow fields in this mixin
`java.util.Collection<org.spongepowered.asm.lib.tree.MethodNode>`	`getShadowMethods()` Get shadow methods in this mixin
`ClassSignature`	`getSignature()` Get the signature for this mixin class
`java.lang.String`	`getSourceFile()` Return the source file name for the mixin
`SourceMap.File`	`getStratum()` Get the SourceMap stratum for this mixin
`org.spongepowered.asm.mixin.transformer.TargetClassContext`	`getTarget()` Get the target class context
`ClassInfo`	`getTargetClassInfo()` Get the target classinfo
`org.spongepowered.asm.lib.tree.ClassNode`	`getTargetClassNode()` Get the target class
`java.lang.String`	`getTargetClassRef()` Get the target class reference
`Target`	`getTargetMethod(org.spongepowered.asm.lib.tree.MethodNode method)` Get a target method handle from the target class
`java.lang.String`	`getUniqueName(org.spongepowered.asm.lib.tree.FieldNode field)` Obtain a unique name for the specified field from the target class context
`java.lang.String`	`getUniqueName(org.spongepowered.asm.lib.tree.MethodNode method, boolean preservePrefix)` Obtain a unique name for the specified method from the target class context
`void`	`postApply(java.lang.String transformedName, org.spongepowered.asm.lib.tree.ClassNode targetClass)` Called immediately after the mixin is applied to targetClass
`void`	`preApply(java.lang.String transformedName, org.spongepowered.asm.lib.tree.ClassNode targetClass)` Called immediately before the mixin is applied to targetClass
`void`	`prepareInjections()` Scans the target class for injector methods and prepares discovered injectors
`boolean`	`requireOverwriteAnnotations()` Get whether overwrite annotations are required for methods in this mixin
`protected void`	`requireVersion(int version)` Mark this mixin as requiring the specified class version in the context of the current target
`boolean`	`shouldSetSourceFile()` Get whether to propogate the source file attribute from a mixin onto the target class
`java.lang.String`	`toString()`
`void`	`transformDescriptor(org.spongepowered.asm.lib.tree.FieldNode field)` Transforms a field descriptor in the context of this mixin target
`void`	`transformDescriptor(MemberRef member)` Transforms a method or field reference descriptor in the context of this mixin target
`void`	`transformDescriptor(org.spongepowered.asm.lib.tree.MethodNode method)` Transforms a method descriptor in the context of this mixin target
`void`	`transformDescriptor(org.spongepowered.asm.lib.tree.TypeInsnNode typeInsn)` Transforms a type insn descriptor in the context of this mixin target
`void`	`transformMethod(org.spongepowered.asm.lib.tree.MethodNode method)` Handles "re-parenting" the method supplied, changes all references to the mixin class to refer to the target class (for field accesses and method invocations) and also handles fixing up the targets of INVOKESPECIAL opcodes for mixins with detached targets.
`protected void`	`upgradeMethodRef(org.spongepowered.asm.lib.tree.MethodNode containingMethod, MemberRef methodRef, ClassInfo.Method method)`
`protected void`	`upgradeMethods()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getEnvironment
```
public MixinEnvironment getEnvironment()
```
    Get the environment of the owning mixin config
    
    Returns:
    
    mixin parent environment
  - getOption
```
public boolean getOption(MixinEnvironment.Option option)
```
    Description copied from interface: IMixinContext
    
    Retrieve the value of the specified option from the environment this mixin belongs to.
    
    Specified by:
    
    getOption in interface IMixinContext
    
    Parameters:
    
    option - option to check
    
    Returns:
    
    option value
  - getClassNode
```
public org.spongepowered.asm.lib.tree.ClassNode getClassNode()
```
    Get the mixin tree
    
    Returns:
    
    mixin tree
  - getClassName
```
public java.lang.String getClassName()
```
    Get the mixin class name
    
    Specified by:
    
    getClassName in interface IMixinContext
    
    Returns:
    
    the mixin class name
  - getClassRef
```
public java.lang.String getClassRef()
```
    Get the internal class name
    
    Specified by:
    
    getClassRef in interface IMixinContext
    
    Returns:
    
    class reference
  - getTarget
```
public org.spongepowered.asm.mixin.transformer.TargetClassContext getTarget()
```
    Get the target class context
    
    Returns:
    
    the target class context
  - getTargetClassRef
```
public java.lang.String getTargetClassRef()
```
    Get the target class reference
    
    Specified by:
    
    getTargetClassRef in interface IMixinContext
    
    Returns:
    
    the reference of the target class (only valid on single-target mixins)
  - getTargetClassNode
```
public org.spongepowered.asm.lib.tree.ClassNode getTargetClassNode()
```
    Get the target class
    
    Returns:
    
    the target class
  - getTargetClassInfo
```
public ClassInfo getTargetClassInfo()
```
    Get the target classinfo
    
    Returns:
    
    the target class info
  - getClassInfo
```
protected ClassInfo getClassInfo()
```
    Get the class info for this class
    
    Returns:
    
    the local class info
  - getSignature
```
public ClassSignature getSignature()
```
    Get the signature for this mixin class
    
    Returns:
    
    signature
  - getStratum
```
public SourceMap.File getStratum()
```
    Get the SourceMap stratum for this mixin
    
    Returns:
    
    stratum
  - getMinRequiredClassVersion
```
public int getMinRequiredClassVersion()
```
    Get the minimum required class version for this mixin
  - getDefaultRequiredInjections
```
public int getDefaultRequiredInjections()
```
    Get the defined value for the Inject.require() parameter on injectors defined in mixins in this configuration.
    
    Returns:
    
    default require value
  - getDefaultInjectorGroup
```
public java.lang.String getDefaultInjectorGroup()
```
    Get the defined injector group for injectors
    
    Returns:
    
    default group name
  - getMaxShiftByValue
```
public int getMaxShiftByValue()
```
    Get the max shift "by" value for the parent config
    
    Returns:
    
    max shift by value
  - getInjectorGroups
```
public InjectorGroupInfo.Map getInjectorGroups()
```
    Get the injector groups for this target
    
    Returns:
    
    injector groups
  - requireOverwriteAnnotations
```
public boolean requireOverwriteAnnotations()
```
    Get whether overwrite annotations are required for methods in this mixin
    
    Returns:
    
    true if overwrite methods must be annoated with Overwrite
  - findRealType
```
public ClassInfo findRealType(ClassInfo mixin)
```
    Find the corresponding class type for the supplied mixin class in this mixin target's hierarchy
    
    Parameters:
    
    mixin - Mixin class to discover
    
    Returns:
    
    Transformed
  - transformMethod
```
public void transformMethod(org.spongepowered.asm.lib.tree.MethodNode method)
```
    Handles "re-parenting" the method supplied, changes all references to the mixin class to refer to the target class (for field accesses and method invocations) and also handles fixing up the targets of INVOKESPECIAL opcodes for mixins with detached targets.
    
    Parameters:
    
    method - Method to transform
  - transformDescriptor
```
public void transformDescriptor(org.spongepowered.asm.lib.tree.FieldNode field)
```
    Transforms a field descriptor in the context of this mixin target
    
    Parameters:
    
    field - Field node to transform
  - transformDescriptor
```
public void transformDescriptor(org.spongepowered.asm.lib.tree.MethodNode method)
```
    Transforms a method descriptor in the context of this mixin target
    
    Parameters:
    
    method - Method node to transform
  - transformDescriptor
```
public void transformDescriptor(MemberRef member)
```
    Transforms a method or field reference descriptor in the context of this mixin target
    
    Parameters:
    
    member - Reference to the method or field
  - transformDescriptor
```
public void transformDescriptor(org.spongepowered.asm.lib.tree.TypeInsnNode typeInsn)
```
    Transforms a type insn descriptor in the context of this mixin target
    
    Parameters:
    
    typeInsn - Type instruction node to transform
  - getTargetMethod
```
public Target getTargetMethod(org.spongepowered.asm.lib.tree.MethodNode method)
```
    Get a target method handle from the target class
    
    Specified by:
    
    getTargetMethod in interface IMixinContext
    
    Parameters:
    
    method - method to get a target handle for
    
    Returns:
    
    new or existing target handle for the supplied method
  - requireVersion
```
protected void requireVersion(int version)
```
    Mark this mixin as requiring the specified class version in the context of the current target
    
    Parameters:
    
    version - version to require
  - getExtensions
```
public Extensions getExtensions()
```
    Description copied from interface: IMixinContext
    
    Get the mixin transformer extension manager
    
    Specified by:
    
    getExtensions in interface IMixinContext
  - getMixin
```
public IMixinInfo getMixin()
```
    Description copied from interface: IMixinContext
    
    Get the mixin info
    
    Specified by:
    
    getMixin in interface IMixinContext
  - getPriority
```
public int getPriority()
```
    Get the mixin priority
    
    Specified by:
    
    getPriority in interface IMixinContext
    
    Returns:
    
    the priority (only meaningful in relation to other mixins)
  - getInterfaces
```
public java.util.Set<java.lang.String> getInterfaces()
```
    Get all interfaces for this mixin
    
    Returns:
    
    mixin interfaces
  - getShadowMethods
```
public java.util.Collection<org.spongepowered.asm.lib.tree.MethodNode> getShadowMethods()
```
    Get shadow methods in this mixin
    
    Returns:
    
    shadow methods in the mixin
  - getMethods
```
public java.util.List<org.spongepowered.asm.lib.tree.MethodNode> getMethods()
```
    Get methods to mixin
    
    Returns:
    
    non-shadow methods in the mixin
  - getShadowFields
```
public java.util.Set<java.util.Map.Entry<org.spongepowered.asm.lib.tree.FieldNode,org.spongepowered.asm.mixin.transformer.ClassInfo.Field>> getShadowFields()
```
    Get shadow fields in this mixin
    
    Returns:
    
    shadow fields in the mixin
  - getFields
```
public java.util.List<org.spongepowered.asm.lib.tree.FieldNode> getFields()
```
    Get fields to mixin
    
    Returns:
    
    non-shadow fields in the mixin
  - getLoggingLevel
```
public org.apache.logging.log4j.Level getLoggingLevel()
```
    Get the logging level for this mixin
    
    Returns:
    
    the logging level
  - shouldSetSourceFile
```
public boolean shouldSetSourceFile()
```
    Get whether to propogate the source file attribute from a mixin onto the target class
    
    Returns:
    
    true if the sourcefile property should be set on the target class
  - getSourceFile
```
public java.lang.String getSourceFile()
```
    Return the source file name for the mixin
    
    Returns:
    
    mixin source file
  - getReferenceMapper
```
public IReferenceMapper getReferenceMapper()
```
    Description copied from interface: IMixinContext
    
    Get the reference mapper for this mixin
    
    Specified by:
    
    getReferenceMapper in interface IMixinContext
    
    Returns:
    
    ReferenceMapper instance (can be null)
  - preApply
```
public void preApply(java.lang.String transformedName,
                     org.spongepowered.asm.lib.tree.ClassNode targetClass)
```
    Called immediately before the mixin is applied to targetClass
    
    Parameters:
    
    transformedName - Target class's transformed name
    
    targetClass - Target class
  - postApply
```
public void postApply(java.lang.String transformedName,
                      org.spongepowered.asm.lib.tree.ClassNode targetClass)
```
    Called immediately after the mixin is applied to targetClass
    
    Parameters:
    
    transformedName - Target class's transformed name
    
    targetClass - Target class
  - getUniqueName
```
public java.lang.String getUniqueName(org.spongepowered.asm.lib.tree.MethodNode method,
                                      boolean preservePrefix)
```
    Obtain a unique name for the specified method from the target class context
    
    Parameters:
    
    method - method to obtain a name for
    
    preservePrefix - true to preserve the method prefix (decorate as postfix) otherwise decorates as infix
    
    Returns:
    
    unique method name
  - getUniqueName
```
public java.lang.String getUniqueName(org.spongepowered.asm.lib.tree.FieldNode field)
```
    Obtain a unique name for the specified field from the target class context
    
    Parameters:
    
    field - field to obtain a name for
    
    Returns:
    
    unique field name
  - prepareInjections
```
public void prepareInjections()
```
    Scans the target class for injector methods and prepares discovered injectors
  - applyInjections
```
public void applyInjections()
```
    Apply injectors discovered in the prepareInjections() pass
  - generateAccessors
```
public java.util.List<org.spongepowered.asm.lib.tree.MethodNode> generateAccessors()
```
    Expand accessor methods mixed into the target class by populating the method bodies
  - upgradeMethods
```
protected void upgradeMethods()
```
  - upgradeMethodRef
```
protected void upgradeMethodRef(org.spongepowered.asm.lib.tree.MethodNode containingMethod,
                                MemberRef methodRef,
                                ClassInfo.Method method)
```

Class MixinTargetContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toString

getEnvironment

getOption

getClassNode

getClassName

getClassRef

getTarget

getTargetClassRef

getTargetClassNode

getTargetClassInfo

getClassInfo

getSignature

getStratum

getMinRequiredClassVersion

getDefaultRequiredInjections

getDefaultInjectorGroup

getMaxShiftByValue

getInjectorGroups

requireOverwriteAnnotations

findRealType

transformMethod

transformDescriptor

transformDescriptor

transformDescriptor

transformDescriptor

getTargetMethod

requireVersion

getExtensions

getMixin

getPriority

getInterfaces

getShadowMethods

getMethods

getShadowFields

getFields

getLoggingLevel

shouldSetSourceFile

getSourceFile

getReferenceMapper

preApply

postApply

getUniqueName

getUniqueName

prepareInjections

applyInjections

generateAccessors

upgradeMethods

upgradeMethodRef