Package dev.denwav.hypo.mappings.contributors

Class RemoveUnusedMappings

java.lang.Object

dev.denwav.hypo.mappings.contributors.RemoveUnusedMappings

All Implemented Interfaces:

ChangeContributor

public class RemoveUnusedMappings
extends Object
implements ChangeContributor

Removes any class, method, field, or method parameter mappings which target classes or members or parameters which don't exist.

Method Summary

Modifier and Type	Method	Description
void	contribute(@Nullable ClassData currentClass, @Nullable ClassMapping<?,?> classMapping, @NotNull HypoContext context, @NotNull ChangeRegistry registry)	Submit mappings changes and class mappings changes to the ChangeRegistry based on analysis of the given ClassData and ClassMapping.
static @NotNull RemoveUnusedMappings	create()	Create a new instance of RemoveUnusedMappings.
@NotNull String	name()	The name of this change contributor.

Methods inherited from class java.lang.Object

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

Method Details

create

@Contract(value="-> new",
          pure=true)
@NotNull
public static @NotNull RemoveUnusedMappings create()

Create a new instance of RemoveUnusedMappings.

Returns:

A new instance of RemoveUnusedMappings.

contribute

public void contribute(@Nullable
 @Nullable ClassData currentClass,
 @Nullable
 @Nullable ClassMapping<?,?> classMapping,
 @NotNull
 @NotNull HypoContext context,
 @NotNull
 @NotNull ChangeRegistry registry)

Description copied from interface: ChangeContributor

Submit mappings changes and class mappings changes to the ChangeRegistry based on analysis of the given ClassData and ClassMapping.

If currentClass is null that means the ClassMapping exists without a corresponding ClassData in the HypoContext.

If classMapping is null that means the ClassData exists in the HypoContext without a corresponding ClassMapping in the mapping set.

Either currentClass or classMapping may be null, but they cannot both be null at the same time. They will usually both be present.

This contributor may submit any number of mappings changes to the ChangeRegistry, but generally it should only submit changes relevant to the current ClassData and/or ClassMapping being processed.

Specified by:

contribute in interface ChangeContributor

Parameters:

currentClass - The ClassData for this mapping, may be null if the mapping exists without a corresponding class in the context.

classMapping - The ClassMapping for this class data, may be null if the class exists without a corresponding mapping in the mapping set.

context - The HypoContext for this execution.

registry - The ChangeRegistry to submit mappings changes to.

name

@NotNull
public @NotNull String name()

Description copied from interface: ChangeContributor

The name of this change contributor. By contention the name of a contributor is typically its class name, but that is not a requirement. If the contributor has config values set on it which changes its behavior it provably makes sense to include them in the name as well somehow.

Change contributor names are used for error reporting and debugging purposes, so in any case the name should be clear and easy to understand which contributor it's referring to.

Specified by:

name in interface ChangeContributor

Returns:

The name of this change contributor.