org.spongepowered.asm.mixin.injection.struct

Class MemberInfo

java.lang.Object

org.spongepowered.asm.mixin.injection.struct.MemberInfo

public final class MemberInfo
extends java.lang.Object

Information bundle about a member (method or field) parsed from a String token in another annotation, this is used where target members need to be specified as Strings in order to parse the String representation to something useful.

Some examples:

   // references a method or field called func_1234_a, if there are multiple
   // members with the same signature, matches the first occurrence
   func_1234_a
   
   // references a method or field called func_1234_a, if there are multiple
   // members with the same signature, matches all occurrences
   func_1234_a*
   
   // references a method called func_1234_a which takes 3 ints and returns
   // a bool
   func_1234_a(III)Z
   
   // references a field called field_5678_z which is a String
   field_5678_z:Ljava/lang/String;
   
   // references a ctor which takes a single String argument 
   <init>(Ljava/lang/String;)V
   
   // references a method called func_1234_a in class foo.bar.Baz
   Lfoo/bar/Baz;func_1234_a
  
   // references a field called field_5678_z in class com.example.Dave
   Lcom/example/Dave;field_5678_z
  
   // references a method called func_1234_a in class foo.bar.Baz which takes
   // three doubles and returns void
   Lfoo/bar/Baz;func_1234_a(DDD)V
   
   // alternate syntax for the same
   foo.bar.Baz.func_1234_a(DDD)V

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	desc Member descriptor, can be null
boolean	matchAll True to match all matching members, not just the first
java.lang.String	name Member name, can be null to match any member
java.lang.String	owner Member owner in internal form but without L;, can be null

Constructor Summary

Constructors

Constructor and Description
MemberInfo(org.spongepowered.asm.lib.tree.AbstractInsnNode insn) Initialise a MemberInfo using the supplied insn which must be an instance of MethodInsnNode or FieldInsnNode.
MemberInfo(IMapping<?> mapping) Initialise a MemberInfo using the supplied mapping object
MemberInfo(java.lang.String name, boolean matchAll) ctor
MemberInfo(java.lang.String name, java.lang.String owner, boolean matchAll) ctor
MemberInfo(java.lang.String name, java.lang.String owner, java.lang.String desc) ctor
MemberInfo(java.lang.String name, java.lang.String owner, java.lang.String desc, boolean matchAll) ctor
MemberInfo(java.lang.String name, java.lang.String owner, java.lang.String desc, boolean matchAll, java.lang.String unparsed) ctor

Method Summary

Modifier and Type	Method and Description
MappingField	asFieldMapping() Returns this MemberInfo as a mapping field
IMapping<?>	asMapping() Returns this MemberInfo as a MappingField or MappingMethod
MappingMethod	asMethodMapping() Returns this MemberInfo as a mapping method
boolean	equals(java.lang.Object obj)
static MemberInfo	fromMapping(IMapping<?> mapping) Return the supplied mapping parsed as a MemberInfo
java.lang.String	getReturnType() Get the return type for this MemberInfo, if the decriptor is present, returns null if the descriptor is absent or if this MemberInfo represents a field
int	hashCode()
boolean	isClassInitialiser() Get whether this member represents a class initialiser
boolean	isConstructor() Get whether this member represents a constructor
boolean	isField() Get whether this MemberInfo is definitely a field, the output of this method is undefined if isFullyQualified() returns false.
boolean	isFullyQualified() Get whether this reference is fully qualified
boolean	isInitialiser() Get whether this member represents a constructor or class initialiser
boolean	matches(java.lang.String name, java.lang.String desc) Test whether this MemberInfo matches the supplied values.
boolean	matches(java.lang.String name, java.lang.String desc, int ordinal) Test whether this MemberInfo matches the supplied values at the specified ordinal.
boolean	matches(java.lang.String owner, java.lang.String name, java.lang.String desc) Test whether this MemberInfo matches the supplied values.
boolean	matches(java.lang.String owner, java.lang.String name, java.lang.String desc, int ordinal) Test whether this MemberInfo matches the supplied values at the specified ordinal.
MemberInfo	move(java.lang.String newOwner) Create a new version of this member with a different owner
static MemberInfo	parse(java.lang.String string) Parse a MemberInfo from a string
static MemberInfo	parse(java.lang.String string, IMixinContext context) Parse a MemberInfo from a string
static MemberInfo	parseAndValidate(java.lang.String string) Parse a MemberInfo from a string and perform validation
static MemberInfo	parseAndValidate(java.lang.String string, IMixinContext context) Parse a MemberInfo from a string and perform validation
MemberInfo	remapUsing(MappingMethod srgMethod, boolean setOwner) Create a remapped version of this member using the supplied method data
java.lang.String	toCtorDesc() Returns the constructor descriptor represented by this MemberInfo, returns null if no descriptor is present.
java.lang.String	toCtorType() Returns the constructor type represented by this MemberInfo
java.lang.String	toDescriptor() Returns this MemberInfo as a java-style descriptor
java.lang.String	toSrg() Deprecated. use m.asMethodMapping().serialise() instead
java.lang.String	toString()
MemberInfo	transform(java.lang.String newDesc) Create a new version of this member with a different descriptor
MemberInfo	validate() Perform ultra-simple validation of the descriptor, checks that the parts of the descriptor are basically sane.

Methods inherited from class java.lang.Object

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

Field Detail

owner

public final java.lang.String owner

Member owner in internal form but without L;, can be null

name

public final java.lang.String name

Member name, can be null to match any member

desc

public final java.lang.String desc

Member descriptor, can be null

matchAll

public final boolean matchAll

True to match all matching members, not just the first

Constructor Detail

MemberInfo

public MemberInfo(java.lang.String name,
                  boolean matchAll)

ctor

Parameters:

name - Member name, must not be null

matchAll - true if this info should match all matching references, or only the first

MemberInfo

public MemberInfo(java.lang.String name,
                  java.lang.String owner,
                  boolean matchAll)

ctor

Parameters:

name - Member name, must not be null

owner - Member owner, can be null otherwise must be in internal form without L;

matchAll - true if this info should match all matching references, or only the first

MemberInfo

public MemberInfo(java.lang.String name,
                  java.lang.String owner,
                  java.lang.String desc)

ctor

Parameters:

name - Member name, must not be null

owner - Member owner, can be null otherwise must be in internal form without L;

desc - Member descriptor, can be null

MemberInfo

public MemberInfo(java.lang.String name,
                  java.lang.String owner,
                  java.lang.String desc,
                  boolean matchAll)

ctor

Parameters:

name - Member name, must not be null

owner - Member owner, can be null otherwise must be in internal form without L;

desc - Member descriptor, can be null

matchAll - True to match all matching members, not just the first

MemberInfo

public MemberInfo(java.lang.String name,
                  java.lang.String owner,
                  java.lang.String desc,
                  boolean matchAll,
                  java.lang.String unparsed)

ctor

Parameters:

name - Member name, must not be null

owner - Member owner, can be null otherwise must be in internal form without L;

desc - Member descriptor, can be null

matchAll - True to match all matching members, not just the first

MemberInfo

public MemberInfo(org.spongepowered.asm.lib.tree.AbstractInsnNode insn)

Initialise a MemberInfo using the supplied insn which must be an instance of MethodInsnNode or FieldInsnNode.

Parameters:

insn - instruction node to copy values from

MemberInfo

public MemberInfo(IMapping<?> mapping)

Initialise a MemberInfo using the supplied mapping object

Parameters:

mapping - Mapping object to copy values from

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toSrg

@Deprecated
public java.lang.String toSrg()

Deprecated. use m.asMethodMapping().serialise() instead

Return this MemberInfo as an SRG mapping

Returns:

SRG representation of this MemberInfo

toDescriptor

public java.lang.String toDescriptor()

Returns this MemberInfo as a java-style descriptor

toCtorType

public java.lang.String toCtorType()

Returns the constructor type represented by this MemberInfo

toCtorDesc

public java.lang.String toCtorDesc()

Returns the constructor descriptor represented by this MemberInfo, returns null if no descriptor is present.

getReturnType

public java.lang.String getReturnType()

Get the return type for this MemberInfo, if the decriptor is present, returns null if the descriptor is absent or if this MemberInfo represents a field

asMapping

public IMapping<?> asMapping()

Returns this MemberInfo as a MappingField or MappingMethod

asMethodMapping

public MappingMethod asMethodMapping()

Returns this MemberInfo as a mapping method

asFieldMapping

public MappingField asFieldMapping()

Returns this MemberInfo as a mapping field

isFullyQualified

public boolean isFullyQualified()

Get whether this reference is fully qualified

Returns:

true if all components of this reference are non-null

isField

public boolean isField()

Get whether this MemberInfo is definitely a field, the output of this method is undefined if isFullyQualified() returns false.

Returns:

true if this is definitely a field

isConstructor

public boolean isConstructor()

Get whether this member represents a constructor

Returns:

true if member name is <init>

isClassInitialiser

public boolean isClassInitialiser()

Get whether this member represents a class initialiser

Returns:

true if member name is <clinit>

isInitialiser

public boolean isInitialiser()

Get whether this member represents a constructor or class initialiser

Returns:

true if member name is <init> or <clinit>

validate

public MemberInfo validate()
                    throws InvalidMemberDescriptorException

Perform ultra-simple validation of the descriptor, checks that the parts of the descriptor are basically sane.

Returns:

fluent

Throws:

InvalidMemberDescriptorException - if any validation check fails

matches

public boolean matches(java.lang.String owner,
                       java.lang.String name,
                       java.lang.String desc)

Test whether this MemberInfo matches the supplied values. Null values are ignored.

Parameters:

owner - Owner to compare with, null to skip

name - Name to compare with, null to skip

desc - Signature to compare with, null to skip

Returns:

true if all non-null values in this reference match non-null arguments supplied to this method

matches

public boolean matches(java.lang.String owner,
                       java.lang.String name,
                       java.lang.String desc,
                       int ordinal)

Test whether this MemberInfo matches the supplied values at the specified ordinal. Null values are ignored.

Parameters:

owner - Owner to compare with, null to skip

name - Name to compare with, null to skip

desc - Signature to compare with, null to skip

ordinal - ordinal position within the class, used to honour the matchAll semantics

Returns:

true if all non-null values in this reference match non-null arguments supplied to this method

matches

public boolean matches(java.lang.String name,
                       java.lang.String desc)

Test whether this MemberInfo matches the supplied values. Null values are ignored.

Parameters:

name - Name to compare with, null to skip

desc - Signature to compare with, null to skip

Returns:

true if all non-null values in this reference match non-null arguments supplied to this method

matches

public boolean matches(java.lang.String name,
                       java.lang.String desc,
                       int ordinal)

Test whether this MemberInfo matches the supplied values at the specified ordinal. Null values are ignored.

Parameters:

name - Name to compare with, null to skip

desc - Signature to compare with, null to skip

ordinal - ordinal position within the class, used to honour the matchAll semantics

Returns:

true if all non-null values in this reference match non-null arguments supplied to this method

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

move

public MemberInfo move(java.lang.String newOwner)

Create a new version of this member with a different owner

Parameters:

newOwner - New owner for this member

transform

public MemberInfo transform(java.lang.String newDesc)

Create a new version of this member with a different descriptor

Parameters:

newDesc - New descriptor for this member

remapUsing

public MemberInfo remapUsing(MappingMethod srgMethod,
                             boolean setOwner)

Create a remapped version of this member using the supplied method data

Parameters:

srgMethod - SRG method data to use

setOwner - True to set the owner as well as the name

Returns:

New MethodInfo with remapped values

parseAndValidate

public static MemberInfo parseAndValidate(java.lang.String string)
                                   throws InvalidMemberDescriptorException

Parse a MemberInfo from a string and perform validation

Parameters:

string - String to parse MemberInfo from

Returns:

parsed MemberInfo

Throws:

InvalidMemberDescriptorException

parseAndValidate

public static MemberInfo parseAndValidate(java.lang.String string,
                                          IMixinContext context)
                                   throws InvalidMemberDescriptorException

Parse a MemberInfo from a string and perform validation

Parameters:

string - String to parse MemberInfo from

context - Context to use for reference mapping

Returns:

parsed MemberInfo

Throws:

InvalidMemberDescriptorException

parse

public static MemberInfo parse(java.lang.String string)

Parse a MemberInfo from a string

Parameters:

string - String to parse MemberInfo from

Returns:

parsed MemberInfo

parse

public static MemberInfo parse(java.lang.String string,
                               IMixinContext context)

Parse a MemberInfo from a string

Parameters:

string - String to parse MemberInfo from

context - Context to use for reference mapping

Returns:

parsed MemberInfo

fromMapping

public static MemberInfo fromMapping(IMapping<?> mapping)

Return the supplied mapping parsed as a MemberInfo

Parameters:

mapping - mapping to parse

Returns:

new MemberInfo