me.jamiemansfield.lorenz

Interface MappingSet

All Known Implementing Classes:

MappingSetImpl

public interface MappingSet

The container for TopLevelClassMappings, allowing for their creating and locating any ClassMapping.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
default MappingSet	addFieldTypeProvider(FieldTypeProvider fieldTypeProvider) Adds the given FieldTypeProvider to this set of mappings.
default Optional<? extends ClassMapping<?>>	computeClassMapping(String obfuscatedName) Attempts to locate a class mapping for the given obfuscated name.
static MappingSet	create() Creates a mapping set, using the default Lorenz model implementation.
static MappingSet	create(MappingSetModelFactory modelFactory) Creates a mapping set, using the given model factory.
TopLevelClassMapping	createTopLevelClassMapping(String obfuscatedName, String deobfuscatedName) Creates a top-level class mapping with the given obfuscated and de-obfuscated names.
default String	deobfuscate(me.jamiemansfield.bombe.type.MethodDescriptor descriptor) Gets the de-obfuscated descriptor of the method.
default String	deobfuscate(me.jamiemansfield.bombe.type.Type type) Gets the de-obfuscated raw view of the type.
default Optional<? extends ClassMapping<?>>	getClassMapping(String obfuscatedName) Gets the class mapping of the given obfuscated name.
CascadingFieldTypeProvider	getFieldTypeProvider() Gets the field type provider in use for this set of mappings.
MappingSetModelFactory	getModelFactory() Gets the underlying model factory, that is used to construct the implementation classes for all the models.
default ClassMapping<?>	getOrCreateClassMapping(String obfuscatedName) Gets, or creates should it not exist, a class mapping, of the given obfuscated name.
default TopLevelClassMapping	getOrCreateTopLevelClassMapping(String obfuscatedName) Gets, or creates should it not exist, a top-level class mapping of the given obfuscated name.
Optional<TopLevelClassMapping>	getTopLevelClassMapping(String obfuscatedName) Gets the top-level class mapping of the given obfuscated name of the class mapping, should it exist.
Collection<TopLevelClassMapping>	getTopLevelClassMappings() Gets an immutable collection of all of the top-level class mappings of the mapping set.
boolean	hasTopLevelClassMapping(String obfuscatedName) Establishes whether the mapping set contains a top-level class mapping of the given obfuscated name.
default MappingSet	removeFieldTypeProvider(FieldTypeProvider fieldTypeProvider) Removes the given FieldTypeProvider to this set of mappings.

Method Detail

create

static MappingSet create()

Creates a mapping set, using the default Lorenz model implementation.

Returns:

The mapping set

Since:

0.2.0

create

static MappingSet create(MappingSetModelFactory modelFactory)

Creates a mapping set, using the given model factory.

Parameters:

modelFactory - The model factory to use

Returns:

The mapping set

Since:

0.3.0

getModelFactory

MappingSetModelFactory getModelFactory()

Gets the underlying model factory, that is used to construct the implementation classes for all the models.

Returns:

The model factory

getTopLevelClassMappings

Collection<TopLevelClassMapping> getTopLevelClassMappings()

Gets an immutable collection of all of the top-level class mappings of the mapping set.

Returns:

The top-level class mappings

createTopLevelClassMapping

TopLevelClassMapping createTopLevelClassMapping(String obfuscatedName,
                                                String deobfuscatedName)

Creates a top-level class mapping with the given obfuscated and de-obfuscated names.

Parameters:

obfuscatedName - The obfuscated name of the top-level class

deobfuscatedName - The de-obfuscated name of the top-level class

Returns:

The top-level class mapping, to allow for chaining

getTopLevelClassMapping

Optional<TopLevelClassMapping> getTopLevelClassMapping(String obfuscatedName)

Gets the top-level class mapping of the given obfuscated name of the class mapping, should it exist.

Parameters:

obfuscatedName - The obfuscated name of the top-level class mapping

Returns:

The top-level class mapping, wrapped in an Optional

getOrCreateTopLevelClassMapping

default TopLevelClassMapping getOrCreateTopLevelClassMapping(String obfuscatedName)

Gets, or creates should it not exist, a top-level class mapping of the given obfuscated name.

Parameters:

obfuscatedName - The obfuscated name of the top-level class mapping

Returns:

The top-level class mapping

hasTopLevelClassMapping

boolean hasTopLevelClassMapping(String obfuscatedName)

Establishes whether the mapping set contains a top-level class mapping of the given obfuscated name.

Parameters:

obfuscatedName - The obfuscated name of the top-level class mapping

Returns:

true should a top-level class mapping of the given obfuscated name exist in the mapping set; false otherwise

getClassMapping

default Optional<? extends ClassMapping<?>> getClassMapping(String obfuscatedName)

Gets the class mapping of the given obfuscated name.

Parameters:

obfuscatedName - The obfuscated name

Returns:

The class mapping, wrapped in an Optional

computeClassMapping

default Optional<? extends ClassMapping<?>> computeClassMapping(String obfuscatedName)

Attempts to locate a class mapping for the given obfuscated name.

This is equivalent to calling getClassMapping(String), except that it will insert a new inner class mapping in case a class mapping for the outer class exists.

This method exists to simplify remapping, where it is important to keep inner classes a part of the outer class.

Parameters:

obfuscatedName - The obfuscated name

Returns:

The class mapping, wrapped in an Optional

getOrCreateClassMapping

default ClassMapping<?> getOrCreateClassMapping(String obfuscatedName)

Gets, or creates should it not exist, a class mapping, of the given obfuscated name.

Parameters:

obfuscatedName - The obfuscated name of the class mapping

Returns:

The class mapping

getFieldTypeProvider

CascadingFieldTypeProvider getFieldTypeProvider()

Gets the field type provider in use for this set of mappings.

Returns:

The field type provider

Since:

0.4.0

addFieldTypeProvider

default MappingSet addFieldTypeProvider(FieldTypeProvider fieldTypeProvider)

Adds the given FieldTypeProvider to this set of mappings.

Parameters:

fieldTypeProvider - The field type provider

Returns:

this, for chaining

Since:

0.4.0

See Also:

CascadingFieldTypeProvider.add(FieldTypeProvider)

removeFieldTypeProvider

default MappingSet removeFieldTypeProvider(FieldTypeProvider fieldTypeProvider)

Removes the given FieldTypeProvider to this set of mappings.

Parameters:

fieldTypeProvider - The field type provider

Returns:

this, for chaining

Since:

0.4.0

See Also:

CascadingFieldTypeProvider.remove(FieldTypeProvider)

deobfuscate

default String deobfuscate(me.jamiemansfield.bombe.type.Type type)

Gets the de-obfuscated raw view of the type.

Parameters:

type - The type to de-obfuscate

Returns:

The de-obfuscated raw view

Since:

0.4.0

deobfuscate

default String deobfuscate(me.jamiemansfield.bombe.type.MethodDescriptor descriptor)

Gets the de-obfuscated descriptor of the method.

Parameters:

descriptor - The descriptor to de-obfuscate

Returns:

The de-obfuscated descriptor

Since:

0.4.0