Package net.fabricmc.mappingio.tree

Interface MappingTree

All Superinterfaces:

MappingTreeView

All Known Subinterfaces:

VisitableMappingTree

All Known Implementing Classes:

MemoryMappingTree

public interface MappingTree
extends MappingTreeView

Mutable mapping tree.

All returned collections are to be assumed unmodifiable, unless explicitly stated otherwise.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MappingTree.ClassMapping
static interface	MappingTree.ElementMapping
static interface	MappingTree.FieldMapping
static interface	MappingTree.MemberMapping
static interface	MappingTree.MetadataEntry
static interface	MappingTree.MethodArgMapping
static interface	MappingTree.MethodMapping
static interface	MappingTree.MethodVarMapping

Nested classes/interfaces inherited from interface net.fabricmc.mappingio.tree.MappingTreeView

MappingTreeView.ClassMappingView, MappingTreeView.ElementMappingView, MappingTreeView.FieldMappingView, MappingTreeView.MemberMappingView, MappingTreeView.MetadataEntryView, MappingTreeView.MethodArgMappingView, MappingTreeView.MethodMappingView, MappingTreeView.MethodVarMappingView

Field Summary

Fields inherited from interface net.fabricmc.mappingio.tree.MappingTreeView

MIN_NAMESPACE_ID, NULL_NAMESPACE_ID, SRC_NAMESPACE_ID

Method Summary

Modifier and Type	Method	Description
MappingTree.ClassMapping	addClass(MappingTree.ClassMapping cls)	Merges a class mapping into the tree.
void	addMetadata(MappingTree.MetadataEntry entry)
@Nullable MappingTree.ClassMapping	getClass(String srcName)
default @Nullable MappingTree.ClassMapping	getClass(String name, int namespace)
Collection<? extends MappingTree.ClassMapping>	getClasses()
default @Nullable MappingTree.FieldMapping	getField(String srcClsName, String srcName, @Nullable String srcDesc)
default @Nullable MappingTree.FieldMapping	getField(String clsName, String name, @Nullable String desc, int namespace)
List<? extends MappingTree.MetadataEntry>	getMetadata()
List<? extends MappingTree.MetadataEntry>	getMetadata(String key)
default @Nullable MappingTree.MethodMapping	getMethod(String srcClsName, String srcName, @Nullable String srcDesc)
default @Nullable MappingTree.MethodMapping	getMethod(String clsName, String name, @Nullable String desc, int namespace)
@Nullable MappingTree.ClassMapping	removeClass(String srcName)	Removes a class mapping from the tree.
boolean	removeMetadata(String key)	Removes all metadata entries whose key is equal to the passed one.
List<String>	setDstNamespaces(List<String> namespaces)	Sets the tree's and all of its contained elements' destination namespace names.
@Nullable String	setSrcNamespace(String namespace)	Sets the tree's and all of its contained elements' source namespace name.

Methods inherited from interface net.fabricmc.mappingio.tree.MappingTreeView

accept, accept, getDstNamespaces, getMaxNamespaceId, getMinNamespaceId, getNamespaceId, getNamespaceName, getSrcNamespace, mapClassName, mapClassName, mapDesc, mapDesc, mapDesc, mapDesc

Method Details

setSrcNamespace

@Nullable
@Nullable String setSrcNamespace(String namespace)

Sets the tree's and all of its contained elements' source namespace name.

If the passed namespace name equals an existing destination namespace's name, implementors may choose to switch the two namespaces around, analogous to MappingSourceNsSwitch. This has to be made clear in the implementation's documentation.

Returns:

The previous source namespace name, if present.

Implementation Requirements:

If switching with an existing destination namespace is requested, but not supported, an UnsupportedOperationException must be thrown.

setDstNamespaces

List<String> setDstNamespaces(List<String> namespaces)

Sets the tree's and all of its contained elements' destination namespace names.

Can be used to reorder and/or drop destination namespaces, analogous to MappingDstNsReorder.

Implementors may allow switching with the source namespace as well, analogous to MappingSourceNsSwitch. This has to be made clear in the implementation's documentation.

Returns:

The previous destination namespaces.

Throws:

IllegalArgumentException - If the passed namespace names contain duplicates.

Implementation Requirements:

If switching with the source namespace is requested, but not supported, an UnsupportedOperationException must be thrown.

getMetadata

List<? extends MappingTree.MetadataEntry> getMetadata()

Specified by:

getMetadata in interface MappingTreeView

Returns:

A modifiable list of all metadata entries currently present in the tree. The list's order is equal to the order in which the entries have been originally added.

getMetadata

List<? extends MappingTree.MetadataEntry> getMetadata(String key)

Specified by:

getMetadata in interface MappingTreeView

Returns:

An unmodifiable list of all currently present metadata entries whose key is equal to the passed one. The list's order is equal to the order in which the entries have been originally added.

addMetadata

void addMetadata(MappingTree.MetadataEntry entry)

removeMetadata

boolean removeMetadata(String key)

Removes all metadata entries whose key is equal to the passed one.

Returns:

Whether any entries have been removed.

getClasses

Collection<? extends MappingTree.ClassMapping> getClasses()

Specified by:

getClasses in interface MappingTreeView

getClass

@Nullable
@Nullable MappingTree.ClassMapping getClass(String srcName)

Specified by:

getClass in interface MappingTreeView

getClass

@Nullable
default @Nullable MappingTree.ClassMapping getClass(String name,
 int namespace)

Specified by:

getClass in interface MappingTreeView

addClass

MappingTree.ClassMapping addClass(MappingTree.ClassMapping cls)

Merges a class mapping into the tree.

Returns:

The MappingTree.ClassMapping instance present in the tree after the merge has occurred. May or may not be the passed instance.

removeClass

@Nullable
@Nullable MappingTree.ClassMapping removeClass(String srcName)

Removes a class mapping from the tree.

Returns:

The removed class mapping, if any.

getField

@Nullable
default @Nullable MappingTree.FieldMapping getField(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc)

Specified by:

getField in interface MappingTreeView

See Also:

• MappingTreeView.getField(String, String, String, int)

getField

@Nullable
default @Nullable MappingTree.FieldMapping getField(String clsName,
 String name,
 @Nullable
 @Nullable String desc,
 int namespace)

Specified by:

getField in interface MappingTreeView

getMethod

@Nullable
default @Nullable MappingTree.MethodMapping getMethod(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc)

Specified by:

getMethod in interface MappingTreeView

See Also:

• MappingTreeView.getMethod(String, String, String, int)

getMethod

@Nullable
default @Nullable MappingTree.MethodMapping getMethod(String clsName,
 String name,
 @Nullable
 @Nullable String desc,
 int namespace)

Specified by:

getMethod in interface MappingTreeView

Parameters:

desc - Can be either complete desc or parameter-only desc.