org.cadixdev.lorenz.model

Interface Mapping<M extends Mapping,P>

Type Parameters:

M - The type of the mapping, used for chaining

P - The type of the parent object

All Superinterfaces:

Reversible<M,P>

All Known Subinterfaces:

ClassMapping<M,P>, FieldMapping, InnerClassMapping, MemberMapping<M,P>, MethodMapping, MethodParameterMapping, TopLevelClassMapping

All Known Implementing Classes:

AbstractClassMappingImpl, AbstractMappingImpl, AbstractMemberMappingImpl, FieldMappingImpl, InnerClassMappingImpl, MethodMappingImpl, MethodParameterMappingImpl, TopLevelClassMappingImpl

public interface Mapping<M extends Mapping,P>
extends Reversible<M,P>

Represents a de-obfuscation mapping for mappable constructs of the Java class format - e.g. classes, fields, and methods.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
M	copy(P parent) Clones this mapping, to a given parent.
String	getDeobfuscatedName() Gets the de-obfuscated name of the member being represented.
String	getFullDeobfuscatedName() Gets the fully-qualified de-obfuscated name of the member.
String	getFullObfuscatedName() Gets the fully-qualified obfuscated name of the member.
MappingSet	getMappings() Gets the MappingSet that the mappings belongs to.
String	getObfuscatedName() Gets the obfuscated name of the member being represented.
default String	getSimpleDeobfuscatedName() Gets the unqualified ("simple") de-obfuscated name of the member.
default String	getSimpleObfuscatedName() Gets the unqualified ("simple") obfuscated name of the member.
boolean	hasDeobfuscatedName() Establishes whether the mapping has had a de-obfuscated name set.
M	merge(M with, P parent) Merges this mapping with another, to a given parent.
M	setDeobfuscatedName(String deobfuscatedName) Sets the de-obfuscated name of the member.

Methods inherited from interface org.cadixdev.lorenz.util.Reversible

reverse

Method Detail

getObfuscatedName

String getObfuscatedName()

Gets the obfuscated name of the member being represented.

Returns:

The obfuscated name

getDeobfuscatedName

String getDeobfuscatedName()

Gets the de-obfuscated name of the member being represented. This can be altered through use of setDeobfuscatedName(String).

Returns:

The de-obfuscated name

setDeobfuscatedName

M setDeobfuscatedName(String deobfuscatedName)

Sets the de-obfuscated name of the member.

Parameters:

deobfuscatedName - The new de-obfuscated name

Returns:

this for chaining

getSimpleObfuscatedName

default String getSimpleObfuscatedName()

Gets the unqualified ("simple") obfuscated name of the member.

Returns:

The simple obfuscated name

Since:

0.4.0

getSimpleDeobfuscatedName

default String getSimpleDeobfuscatedName()

Gets the unqualified ("simple") de-obfuscated name of the member.

Returns:

The simple de-obfuscated name

Since:

0.4.0

getFullObfuscatedName

String getFullObfuscatedName()

Gets the fully-qualified obfuscated name of the member.

Returns:

The fully-qualified obfuscated name

getFullDeobfuscatedName

String getFullDeobfuscatedName()

Gets the fully-qualified de-obfuscated name of the member.

Returns:

The fully-qualified de-obfuscated name

hasDeobfuscatedName

boolean hasDeobfuscatedName()

Establishes whether the mapping has had a de-obfuscated name set.

Returns:

True if the mapping is mapped, false otherwise

getMappings

MappingSet getMappings()

Gets the MappingSet that the mappings belongs to.

Returns:

The owning mapping set

merge

M merge(M with,
        P parent)

Merges this mapping with another, to a given parent.

Parameters:

with - The mapping to merge with

parent - The parent

Returns:

The new mapping

copy

M copy(P parent)

Clones this mapping, to a given parent.

Parameters:

parent - The parent

Returns:

The cloned mapping

Since:

0.5.0