Package dev.denwav.hypo.mappings

Class LorenzUtil

java.lang.Object

dev.denwav.hypo.mappings.LorenzUtil

public final class LorenzUtil
extends Object

General utility for interacting with the Lorenz API. This utility class helps with easing the interactions with Optional and it provides utilities to help with modifying MappingSet models outside of what the standard Lorenz API allows.

Method Summary

Modifier and Type	Method	Description
(package private) static @NotNull MappingSetImpl	checkType(@NotNull MappingSet mappingSet)	Verify the MappingSet is a MappingSetImpl.
(package private) static @NotNull AbstractClassMappingImpl<?,?>	checkType(@NotNull ClassMapping<?,?> mapping)	Verify the ClassMapping is an AbstractClassMappingImpl.
(package private) static @NotNull MethodMappingImpl	checkType(@NotNull MethodMapping mapping)	Verify the MethodMapping is an MethodMappingImpl.
static @NotNull MethodDescriptor	convertDesc(MethodDescriptor desc)	Convert a Bombe MethodDescriptor into a Hypo MethodDescriptor.
static @NotNull JvmType	convertType(Type type)	Convert a Bombe Type into a Hypo JvmType.
static @NotNull Set<@NotNull FieldData>	findField(@NotNull ClassData classData, @NotNull FieldMapping mapping)	Find the set of FieldData the obfuscated name of the given FieldMapping refers to in the given ClassData object.
static @Nullable MethodData	findMethod(@NotNull ClassData classData, @NotNull MethodMapping mapping)	Find MethodData the obfuscated name of the given MethodMapping refers to in the given ClassData object.
static @Nullable ClassMapping<?,?>	getClassMapping(@NotNull MappingSet mappings, @NotNull String obfuscatedName)	Nullable form of MappingSet.getClassMapping(String).
static @Nullable FieldMapping	getFieldMapping(@NotNull ClassMapping<?,?> mapping, @NotNull String name)	Nullable form of ClassMapping.getFieldMapping(String).
static @Nullable FieldMapping	getFieldMapping(@NotNull ClassMapping<?,?> mapping, @NotNull FieldSignature sig)	Nullable form of ClassMapping.getFieldMapping(FieldSignature).
static @NotNull Map<String,FieldMapping>	getFieldsByNameMap(@NotNull ClassMapping<?,?> mapping)	Get the internal map which stores field mappings by name from the given ClassMapping.
static @NotNull Map<FieldSignature,FieldMapping>	getFieldsMap(@NotNull ClassMapping<?,?> mapping)	Get the internal map which stores field mappings by signature from the given ClassMapping.
static @NotNull Map<String,InnerClassMapping>	getInnerClassesMap(@NotNull ClassMapping<?,?> mapping)	Get the internal map which stores inner class mappings from the given ClassMapping.
static @Nullable MethodMapping	getMethodMapping(@NotNull ClassMapping<?,?> mapping, @NotNull String name, @NotNull String desc)	Nullable form of ClassMapping.getMethodMapping(String, String).
static @NotNull Map<MethodSignature,MethodMapping>	getMethodsMap(@NotNull ClassMapping<?,?> mapping)	Get the internal map which stores method mappings from the given ClassMapping.
static @Nullable MethodParameterMapping	getParameterMapping(@NotNull MethodMapping mapping, int index)	Nullable form of MethodMapping.getParameterMapping(int).
static @NotNull Map<Integer,MethodParameterMapping>	getParamsMap(@NotNull MethodMapping mapping)	Get the internal map which stores parameter mappings from the given MethodMapping.
static @NotNull Map<String,TopLevelClassMapping>	getTopLevelClassesMap(@NotNull MappingSet mappingSet)	Get the internal map which stores top level class mappings from the given MappingSet.
static @Nullable FieldType	getType(@NotNull FieldMapping mapping)	The Nullable form of FieldMapping.getType().
(package private) static <T> T	notNull(T t, String fieldName)	Verify t is not null, throwing a NullPointerException specifying the field which is null using the given fieldName.
static void	removeClassMapping(@NotNull ClassMapping<?,?> mapping)	Remove the given ClassMapping from its parent.
static void	removeFieldMapping(@NotNull FieldMapping mapping)	Remove the given FieldMapping from its parent.
static void	removeFieldMapping(@NotNull FieldMapping fieldMapping, @NotNull ClassMapping<?,?> mapping)	Remove the given FieldMapping from the given ClassMapping.
static void	removeInnerClassMapping(@NotNull ClassMapping<?,?> innerClassMapping, @NotNull ClassMapping<?,?> mapping)	Remove the given InnerClassMapping from the given ClassMapping.
static void	removeMethodMapping(@NotNull MethodMapping mapping)	Remove the given MethodMapping from its parent.
static void	removeMethodMapping(@NotNull MethodMapping methodMapping, @NotNull ClassMapping<?,?> mapping)	Remove the given MethodMapping from the given ClassMapping.
static void	removeParamMapping(@NotNull MethodParameterMapping mapping)	Remove the given MethodParameterMapping from its parent.
static void	removeParamMapping(@NotNull MethodParameterMapping paramMappings, @NotNull MethodMapping mapping)	Remove the given MethodParameterMapping from the given MethodMapping.
static void	removeTopLevelClassMapping(@NotNull ClassMapping<?,?> topLevelClassMapping, @NotNull MappingSet mappingSet)	Remove the given TopLevelClassMapping from the given MappingSet.
static <T> T	unwrap(@Nullable Optional<T> opt)	Return a Nullable version of what the given Optional contains.

Methods inherited from class java.lang.Object

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

Method Details

unwrap

@Nullable
public static <T> T unwrap(@Nullable
 @Nullable Optional<T> opt)

Return a Nullable version of what the given Optional contains. This is just a cleaner way of calling orElse(null).

Type Parameters:

T - The type of the optional.

Parameters:

opt - The optional to unwrap.

Returns:

The value the optional contains, or null if it is empty.

findMethod

@Contract(pure=true)
@Nullable
public static @Nullable MethodData findMethod(@NotNull
 @NotNull ClassData classData,
 @NotNull
 @NotNull MethodMapping mapping)

Find MethodData the obfuscated name of the given MethodMapping refers to in the given ClassData object.

Parameters:

classData - The class data to find the method in.

mapping - The mapping to determine the reference from.

Returns:

The MethodData or null if not found.

findField

@Contract(pure=true)
@NotNull
public static @NotNull Set<@NotNull FieldData> findField(@NotNull
 @NotNull ClassData classData,
 @NotNull
 @NotNull FieldMapping mapping)

Find the set of FieldData the obfuscated name of the given FieldMapping refers to in the given ClassData object.

Parameters:

classData - The class data to find the method in.

mapping - The mapping to determine the reference from.

Returns:

The set of FieldData.

convertDesc

@NotNull
public static @NotNull MethodDescriptor convertDesc(@NotNull
 MethodDescriptor desc)

Convert a Bombe MethodDescriptor into a Hypo MethodDescriptor.

Parameters:

desc - The Bombe descriptor to convert.

Returns:

The same descriptor, but in the Hypo model.

convertType

@NotNull
public static @NotNull JvmType convertType(@NotNull
 Type type)

Convert a Bombe Type into a Hypo JvmType.

Parameters:

type - The Bombe type to convert.

Returns:

The same type, but in the Hypo model.

getClassMapping

@Nullable
public static @Nullable ClassMapping<?,?> getClassMapping(@NotNull
 @NotNull MappingSet mappings,
 @NotNull
 @NotNull String obfuscatedName)

Nullable form of MappingSet.getClassMapping(String).

Parameters:

mappings - The mapping set to call.

obfuscatedName - The class name to search for.

Returns:

The ClassMapping, or null if not found.

See Also:

unwrap(Optional)

getMethodMapping

@Nullable
public static @Nullable MethodMapping getMethodMapping(@NotNull
 @NotNull ClassMapping<?,?> mapping,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull String desc)

Nullable form of ClassMapping.getMethodMapping(String, String).

Parameters:

mapping - The class mapping to call.

name - The method name to search for.

desc - The method descriptor to search for.

Returns:

The MethodMapping, or null if not found.

See Also:

unwrap(Optional)

getFieldMapping

@Nullable
public static @Nullable FieldMapping getFieldMapping(@NotNull
 @NotNull ClassMapping<?,?> mapping,
 @NotNull
 @NotNull String name)

Nullable form of ClassMapping.getFieldMapping(String).

Parameters:

mapping - The class mapping to call.

name - The field name to search for.

Returns:

The FieldMapping or null if not found.

See Also:

unwrap(Optional)

getFieldMapping

@Nullable
public static @Nullable FieldMapping getFieldMapping(@NotNull
 @NotNull ClassMapping<?,?> mapping,
 @NotNull
 @NotNull FieldSignature sig)

Nullable form of ClassMapping.getFieldMapping(FieldSignature).

Parameters:

mapping - The class mapping to call.

sig - The FieldSignature to search for.

Returns:

The FieldMapping or null if not found.

See Also:

unwrap(Optional)

getParameterMapping

@Nullable
public static @Nullable MethodParameterMapping getParameterMapping(@NotNull
 @NotNull MethodMapping mapping,
 int index)

Nullable form of MethodMapping.getParameterMapping(int).

Parameters:

mapping - The method mapping to call.

index - The parameter index to search for.

Returns:

The MethodParameterMapping, or null if not found.

See Also:

unwrap(Optional)

getType

@Nullable
public static @Nullable FieldType getType(@NotNull
 @NotNull FieldMapping mapping)

The Nullable form of FieldMapping.getType().

Parameters:

mapping - The field mapping to call.

Returns:

The FieldType or null if not found.

See Also:

unwrap(Optional)

removeClassMapping

public static void removeClassMapping(@NotNull
 @NotNull ClassMapping<?,?> mapping)

Remove the given ClassMapping from its parent.

Parameters:

mapping - The class mapping to remove.

removeMethodMapping

public static void removeMethodMapping(@NotNull
 @NotNull MethodMapping mapping)

Remove the given MethodMapping from its parent.

Parameters:

mapping - The method mapping to remove.

removeFieldMapping

public static void removeFieldMapping(@NotNull
 @NotNull FieldMapping mapping)

Remove the given FieldMapping from its parent.

Parameters:

mapping - The field mapping to remove.

removeParamMapping

public static void removeParamMapping(@NotNull
 @NotNull MethodParameterMapping mapping)

Remove the given MethodParameterMapping from its parent.

Parameters:

mapping - The method parameter mapping to remove.

removeTopLevelClassMapping

public static void removeTopLevelClassMapping(@NotNull
 @NotNull ClassMapping<?,?> topLevelClassMapping,
 @NotNull
 @NotNull MappingSet mappingSet)

Remove the given TopLevelClassMapping from the given MappingSet.

This method does nothing if topLevelClassMapping is not a TopLevelClassMapping.

Parameters:

topLevelClassMapping - The class mapping to remove.

mappingSet - The mapping set to remove the class from.

removeInnerClassMapping

public static void removeInnerClassMapping(@NotNull
 @NotNull ClassMapping<?,?> innerClassMapping,
 @NotNull
 @NotNull ClassMapping<?,?> mapping)

Remove the given InnerClassMapping from the given ClassMapping.

This method does nothing if innerClassMapping is not a InnerClassMapping.

Parameters:

innerClassMapping - The class mapping to remove.

mapping - The class mapping to remove the class from.

removeFieldMapping

public static void removeFieldMapping(@NotNull
 @NotNull FieldMapping fieldMapping,
 @NotNull
 @NotNull ClassMapping<?,?> mapping)

Remove the given FieldMapping from the given ClassMapping.

Parameters:

fieldMapping - The field mapping to remove.

mapping - The class mapping to remove the field from.

removeMethodMapping

public static void removeMethodMapping(@NotNull
 @NotNull MethodMapping methodMapping,
 @NotNull
 @NotNull ClassMapping<?,?> mapping)

Remove the given MethodMapping from the given ClassMapping.

Parameters:

methodMapping - The method mapping to remove.

mapping - The class mapping to remove the method from.

removeParamMapping

public static void removeParamMapping(@NotNull
 @NotNull MethodParameterMapping paramMappings,
 @NotNull
 @NotNull MethodMapping mapping)

Remove the given MethodParameterMapping from the given MethodMapping.

Parameters:

paramMappings - The method parameter mapping to remove.

mapping - The method mapping to remove the parameter from.

getTopLevelClassesMap

@Contract(pure=true)
@NotNull
public static @NotNull Map<String,TopLevelClassMapping> getTopLevelClassesMap(@NotNull
 @NotNull MappingSet mappingSet)

Get the internal map which stores top level class mappings from the given MappingSet.

Parameters:

mappingSet - The mapping set to retrieve the map from.

Returns:

The internal map of top level class mappings.

getInnerClassesMap

@Contract(pure=true)
@NotNull
public static @NotNull Map<String,InnerClassMapping> getInnerClassesMap(@NotNull
 @NotNull ClassMapping<?,?> mapping)

Get the internal map which stores inner class mappings from the given ClassMapping.

Parameters:

mapping - The class mapping to retrieve the map from.

Returns:

The internal map of inner class mappings.

getFieldsMap

@Contract(pure=true)
@NotNull
public static @NotNull Map<FieldSignature,FieldMapping> getFieldsMap(@NotNull
 @NotNull ClassMapping<?,?> mapping)

Get the internal map which stores field mappings by signature from the given ClassMapping.

Parameters:

mapping - The class mapping to retrieve the map from.

Returns:

The internal map of field mappings by signature.

getFieldsByNameMap

@Contract(pure=true)
@NotNull
public static @NotNull Map<String,FieldMapping> getFieldsByNameMap(@NotNull
 @NotNull ClassMapping<?,?> mapping)

Get the internal map which stores field mappings by name from the given ClassMapping.

Parameters:

mapping - The class mapping to retrieve the map from.

Returns:

The internal map of field mappings by name.

getMethodsMap

@Contract(pure=true)
@NotNull
public static @NotNull Map<MethodSignature,MethodMapping> getMethodsMap(@NotNull
 @NotNull ClassMapping<?,?> mapping)

Get the internal map which stores method mappings from the given ClassMapping.

Parameters:

mapping - The class mapping to retrieve the map from.

Returns:

The internal map of method mappings.

getParamsMap

@Contract(pure=true)
@NotNull
public static @NotNull Map<Integer,MethodParameterMapping> getParamsMap(@NotNull
 @NotNull MethodMapping mapping)

Get the internal map which stores parameter mappings from the given MethodMapping.

Parameters:

mapping - The method mapping to retrieve the map from.

Returns:

The internal map of parameter mappings.

checkType

@Contract(value="_ -> param1",
          pure=true)
@NotNull
static @NotNull MappingSetImpl checkType(@NotNull
 @NotNull MappingSet mappingSet)

Verify the MappingSet is a MappingSetImpl.

Parameters:

mappingSet - The MappingSet to verify.

Returns:

The same mapping set, cast to MappingSetImpl.

checkType

@Contract(value="_ -> param1",
          pure=true)
@NotNull
static @NotNull AbstractClassMappingImpl<?,?> checkType(@NotNull
 @NotNull ClassMapping<?,?> mapping)

Verify the ClassMapping is an AbstractClassMappingImpl.

Parameters:

mapping - The ClassMapping to verify.

Returns:

The same mapping, cast to AbstractClassMappingImpl.

checkType

@Contract(value="_ -> param1",
          pure=true)
@NotNull
static @NotNull MethodMappingImpl checkType(@NotNull
 @NotNull MethodMapping mapping)

Verify the MethodMapping is an MethodMappingImpl.

Parameters:

mapping - The MethodMapping to verify.

Returns:

The same mapping, cast to MethodMappingImpl.

notNull

@Contract(value="null, _ -> fail; !null, _ -> param1",
          pure=true)
@NotNull
static <T> T notNull(@Nullable
 T t,
 String fieldName)

Verify t is not null, throwing a NullPointerException specifying the field which is null using the given fieldName.

Type Parameters:

T - The type of the field.

Parameters:

t - The value to verify is not null.

fieldName - The name of the field the value came from.

Returns:

The given value as non-null.