Package dev.denwav.hypo.mappings

Class MappingsCompletionManager

java.lang.Object

dev.denwav.hypo.mappings.MappingsCompletionManager

public class MappingsCompletionManager
extends Object

Manager for the mappings completion process. Mappings completion is the combination of bytecode analysis with hypo-model and hypo-hydrate with mappings analysis using change contributors.

Classes which implement ChangeContributor run on ClassData in a HypoContext along with the current MappingSet and submit changes to make to the current MappingSet via the ChangeRegistry. This class, the manager, handles the orchestration of each of these steps. This class does assume the HypoContext has already been hydrated before it's passed in to the create() method.

Due to the limitations ChangeRegistry has in terms of dis-allowing multiple changes from targeting the same class or member mapping, ChangeChain can be used to chain together sets of changes to be run serially rather than in parallel. It's generally recommended to only run compatible change contributors in parallel - compatible meaning they won't submit changes against the same target.

See Also:

ChangeRegistry, ChangeChain

Method Summary

Modifier and Type	Method	Description
@NotNull ChangeRegistry	completeMappings(@NotNull MappingSet mappings, @NotNull List<@NotNull ChangeContributor> contributors)	Run completion over the given MappingSet using the given list of change contributors.
static @NotNull MappingsCompletionManager	create(@NotNull HypoContext context)	Create a new instance of MappingsCompletionManager for the given HypoContext.

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 MappingsCompletionManager create(@NotNull
 @NotNull HypoContext context)

Create a new instance of MappingsCompletionManager for the given HypoContext.

The given HypoContext is expected to have already gone through hydration.

Parameters:

context - The HypoContext to use for mappings completion.

Returns:

The new MappingsCompletionManager.

completeMappings

@NotNull
public @NotNull ChangeRegistry completeMappings(@NotNull
 @NotNull MappingSet mappings,
 @NotNull
 @NotNull List<@NotNull ChangeContributor> contributors)
                                         throws HypoException

Run completion over the given MappingSet using the given list of change contributors. This will return a ChangeRegistry which has all of the changes submitted from the given change contributors ready to apply with ChangeRegistry.applyChanges(MappingSet).

Parameters:

mappings - The MappingSet to complete.

contributors - The change contributors to run against the mappings.

Returns:

A ChangeRegistry filled in with the changes submitted by the given contributors.

Throws:

HypoException - If one of the change contributors fails.