net.lenni0451.commons.asm.mappings

Class Mappings

java.lang.Object

org.objectweb.asm.commons.Remapper

net.lenni0451.commons.asm.mappings.Mappings

public class Mappings
extends org.objectweb.asm.commons.Remapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mappings.ReverseCacheMode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	classMappings Class names are separated by /.
protected java.util.Map<java.lang.String,java.lang.String>	fieldMappings Field names are separated by . from the owner and with : from the descriptor.
protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>>	mapInitializer
protected java.util.Map<java.lang.String,java.lang.String>	methodMappings Method names are separated by . from the owner.
protected java.util.Map<java.lang.String,java.lang.String>	packageMappings Package names are separated by /.

Constructor Summary

Constructors

Constructor and Description
Mappings()
Mappings(Mappings mappings, java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,java.lang.String>> mapCopier)
Mappings(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer)

Method Summary

Modifier and Type	Method and Description
Mappings	addClassMapping(java.lang.String from, java.lang.String to) Add a class mapping.
Mappings	addClassMapping(java.lang.String from, java.lang.String to, boolean skipExisting) Add a class mapping.
Mappings	addFieldMapping(java.lang.String owner, java.lang.String name, java.lang.String descriptor, java.lang.String newName) Add a field mapping.
Mappings	addFieldMapping(java.lang.String owner, java.lang.String name, java.lang.String descriptor, java.lang.String newName, boolean skipExisting) Add a field mapping.
Mappings	addMethodMapping(java.lang.String owner, java.lang.String name, java.lang.String descriptor, java.lang.String newName) Add a method mapping.
Mappings	addMethodMapping(java.lang.String owner, java.lang.String name, java.lang.String descriptor, java.lang.String newName, boolean skipExisting) Add a method mapping.
Mappings	addPackageMapping(java.lang.String from, java.lang.String to) Add a package mapping.
Mappings	addPackageMapping(java.lang.String from, java.lang.String to, boolean skipExisting) Add a package mapping.
Mappings	copy()
Mappings	copy(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer) Get a copy of these mappings with a custom map initializer.
Mappings	emptyCopy()
Mappings	emptyCopy(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer) Get an empty copy of these mappings with a custom map initializer.
java.util.Map<java.lang.String,java.lang.String>	getClassMappings()
java.util.Map<java.lang.String,java.lang.String>	getFieldMappings()
java.util.Map<java.lang.String,java.lang.String>	getMethodMappings()
java.util.Map<java.lang.String,java.lang.String>	getPackageMappings()
boolean	isEmpty()
Mappings	isolate() Isolate this instance from the reversed one.
java.lang.String	map(java.lang.String internalName)
java.lang.String	mapClassPackage(java.lang.String internalName) Map the package of a class name.
java.lang.String	mapFieldName(java.lang.String owner, java.lang.String name, java.lang.String descriptor)
java.lang.String	mapMethodName(java.lang.String owner, java.lang.String name, java.lang.String descriptor)
java.lang.String	mapPackageName(java.lang.String name)
Mappings	reverse() Reverse the mappings using the Mappings.ReverseCacheMode.UPDATE mode.
Mappings	reverse(Mappings.ReverseCacheMode mode) Reverse the mappings using the given mode.
int	size()
java.lang.String	toString()

Methods inherited from class org.objectweb.asm.commons.Remapper

createRemappingSignatureAdapter, createSignatureRemapper, mapAnnotationAttributeName, mapDesc, mapInnerClassName, mapInvokeDynamicMethodName, mapMethodDesc, mapModuleName, mapRecordComponentName, mapSignature, mapType, mapTypes, mapValue

Methods inherited from class java.lang.Object

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

Field Detail

mapInitializer

protected final java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer

packageMappings

protected final java.util.Map<java.lang.String,java.lang.String> packageMappings

Package names are separated by /.
If a package equals . it is the default package.
org/example -> org/example2

classMappings

protected final java.util.Map<java.lang.String,java.lang.String> classMappings

Class names are separated by /.
org/example/SomeClass -> org/example/NewName

fieldMappings

protected final java.util.Map<java.lang.String,java.lang.String> fieldMappings

Field names are separated by . from the owner and with : from the descriptor.
The descriptor is optional but highly recommended to avoid conflicts.
org/example/SomeClass.fieldName:I -> newFieldName

methodMappings

protected final java.util.Map<java.lang.String,java.lang.String> methodMappings

Method names are separated by . from the owner. The descriptor is directly appended to the name.
org/example/SomeClass.methodName(I)V -> newMethodName

Constructor Detail

Mappings

public Mappings()

Mappings

public Mappings(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer)

Mappings

public Mappings(Mappings mappings,
                java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,java.lang.String>> mapCopier)

Method Detail

getPackageMappings

public java.util.Map<java.lang.String,java.lang.String> getPackageMappings()

Returns:

The package mappings

addPackageMapping

public Mappings addPackageMapping(java.lang.String from,
                                  java.lang.String to)

Add a package mapping.
If a package is . it is the default package.
org/example -> org/example2

Parameters:

from - The source package

to - The mapped package

Returns:

This instance

See Also:

addPackageMapping(String, String, boolean)

addPackageMapping

public Mappings addPackageMapping(java.lang.String from,
                                  java.lang.String to,
                                  boolean skipExisting)

Add a package mapping.
If a package is . it is the default package.
org/example -> org/example2

Parameters:

from - The source package

to - The mapped package

skipExisting - If the mapping should be skipped if it already exists

Returns:

This instance

mapPackageName

public java.lang.String mapPackageName(java.lang.String name)

Overrides:

mapPackageName in class org.objectweb.asm.commons.Remapper

mapClassPackage

public java.lang.String mapClassPackage(java.lang.String internalName)

Map the package of a class name.

Parameters:

internalName - The internal name of the class

Returns:

The mapped class name

getClassMappings

public java.util.Map<java.lang.String,java.lang.String> getClassMappings()

Returns:

The class mappings

addClassMapping

public Mappings addClassMapping(java.lang.String from,
                                java.lang.String to)

Add a class mapping.
org/example/SomeClass -> org/example/NewName

Parameters:

from - The source class

to - The mapped class

Returns:

This instance

addClassMapping

public Mappings addClassMapping(java.lang.String from,
                                java.lang.String to,
                                boolean skipExisting)

Add a class mapping.
org/example/SomeClass -> org/example/NewName

Parameters:

from - The source class

to - The mapped class

skipExisting - If the mapping should be skipped if it already exists

Returns:

This instance

map

@Nonnull
public java.lang.String map(java.lang.String internalName)

Overrides:

map in class org.objectweb.asm.commons.Remapper

getFieldMappings

public java.util.Map<java.lang.String,java.lang.String> getFieldMappings()

Returns:

The field mappings

addFieldMapping

public Mappings addFieldMapping(java.lang.String owner,
                                java.lang.String name,
                                @Nullable
                                java.lang.String descriptor,
                                java.lang.String newName)

Add a field mapping.
The descriptor is optional but highly recommended to avoid conflicts.
org/example/SomeClass.fieldName:I -> newFieldName

Parameters:

owner - The owner of the field

name - The name of the field

descriptor - The descriptor of the field

newName - The new name of the field

Returns:

This instance

See Also:

addFieldMapping(String, String, String, String, boolean)

addFieldMapping

public Mappings addFieldMapping(java.lang.String owner,
                                java.lang.String name,
                                @Nullable
                                java.lang.String descriptor,
                                java.lang.String newName,
                                boolean skipExisting)

Add a field mapping.
The descriptor is optional but highly recommended to avoid conflicts.
org/example/SomeClass.fieldName:I -> newFieldName

Parameters:

owner - The owner of the field

name - The name of the field

descriptor - The descriptor of the field

newName - The new name of the field

skipExisting - If the mapping should be skipped if it already exists

Returns:

This instance

mapFieldName

public java.lang.String mapFieldName(java.lang.String owner,
                                     java.lang.String name,
                                     java.lang.String descriptor)

Overrides:

mapFieldName in class org.objectweb.asm.commons.Remapper

getMethodMappings

public java.util.Map<java.lang.String,java.lang.String> getMethodMappings()

Returns:

The method mappings

addMethodMapping

public Mappings addMethodMapping(java.lang.String owner,
                                 java.lang.String name,
                                 java.lang.String descriptor,
                                 java.lang.String newName)

Add a method mapping.
org/example/SomeClass.methodName(I)V -> newMethodName

Parameters:

owner - The owner of the method

name - The name of the method

descriptor - The descriptor of the method

newName - The new name of the method

Returns:

This instance

See Also:

addMethodMapping(String, String, String, String, boolean)

addMethodMapping

public Mappings addMethodMapping(java.lang.String owner,
                                 java.lang.String name,
                                 java.lang.String descriptor,
                                 java.lang.String newName,
                                 boolean skipExisting)

Add a method mapping.
org/example/SomeClass.methodName(I)V -> newMethodName

Parameters:

owner - The owner of the method

name - The name of the method

descriptor - The descriptor of the method

newName - The new name of the method

skipExisting - If the mapping should be skipped if it already exists

Returns:

This instance

mapMethodName

public java.lang.String mapMethodName(java.lang.String owner,
                                      java.lang.String name,
                                      java.lang.String descriptor)

Overrides:

mapMethodName in class org.objectweb.asm.commons.Remapper

size

public int size()

Returns:

The size of all mappings

isEmpty

public boolean isEmpty()

Returns:

If all mappings are empty

emptyCopy

public Mappings emptyCopy()

Returns:

An empty copy of these mappings

emptyCopy

public Mappings emptyCopy(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer)

Get an empty copy of these mappings with a custom map initializer.
This should be overridden by subclasses to return the correct type.

Parameters:

mapInitializer - The map initializer

Returns:

An empty copy of these mappings

copy

public Mappings copy()

Returns:

A copy of these mappings

copy

public Mappings copy(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> mapInitializer)

Get a copy of these mappings with a custom map initializer.
This should be overridden by subclasses to return the correct type.

Parameters:

mapInitializer - The map initializer

Returns:

A copy of these mappings

isolate

public Mappings isolate()

Isolate this instance from the reversed one.
This will remove the reverse reference from this instance and the reverse instance.

Returns:

This instance

reverse

public Mappings reverse()

Reverse the mappings using the Mappings.ReverseCacheMode.UPDATE mode.

Returns:

The reversed mappings

reverse

public Mappings reverse(Mappings.ReverseCacheMode mode)

Reverse the mappings using the given mode.
If the reverse mappings are already cached with the given mode, they will be returned.
Reversing the mappings is an expensive operation and should be cached if used multiple times.

Parameters:

mode - The mode to use

Returns:

The reversed mappings

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object