Package net.fabricmc.mappingio.tree

Class MemoryMappingTree

java.lang.Object

net.fabricmc.mappingio.tree.MemoryMappingTree

All Implemented Interfaces:

MappingVisitor, MappingTree, MappingTreeView, VisitableMappingTree

public final class MemoryMappingTree
extends Object
implements VisitableMappingTree

Nested Class Summary

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

MappingTree.ClassMapping, MappingTree.ElementMapping, MappingTree.FieldMapping, MappingTree.MemberMapping, MappingTree.MetadataEntry, MappingTree.MethodArgMapping, MappingTree.MethodMapping, 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

Constructor Summary

Constructors

Constructor	Description
MemoryMappingTree()
MemoryMappingTree(boolean indexByDstNames)
MemoryMappingTree(MappingTree src)

Method Summary

Modifier and Type	Method	Description
void	accept(MappingVisitor visitor, VisitOrder order)
MappingTree.ClassMapping	addClass(MappingTree.ClassMapping cls)
void	addMetadata(MappingTree.MetadataEntry entry)
@Nullable MappingTree.ClassMapping	getClass(String srcName)
@Nullable MappingTree.ClassMapping	getClass(String name, int namespace)
Collection<? extends MappingTree.ClassMapping>	getClasses()
List<String>	getDstNamespaces()
List<? extends MappingTree.MetadataEntry>	getMetadata()
List<? extends MappingTree.MetadataEntry>	getMetadata(String key)
@Nullable String	getSrcNamespace()
@Nullable MappingTree.ClassMapping	removeClass(String srcName)
boolean	removeMetadata(String key)	Removes all metadata entries whose key is equal to the passed one.
void	reset()	Reset the visitor including any chained visitors to allow for another independent visit (excluding visitEnd=false).
List<String>	setDstNamespaces(List<String> namespaces)
void	setHierarchyInfoProvider(@Nullable HierarchyInfoProvider<?> provider)
void	setIndexByDstNames(boolean indexByDstNames)
@Nullable String	setSrcNamespace(String namespace)
boolean	visitClass(String srcName)
void	visitComment(MappedElementKind targetKind, String comment)	Comment for the specified element (last content-visited or any parent).
void	visitDstName(MappedElementKind targetKind, int namespace, String name)	Destination name for the current element.
boolean	visitElementContent(MappedElementKind targetKind)	Determine whether the element content (comment, sub-elements) should be visited.
boolean	visitEnd()	Finish the visitation pass.
boolean	visitField(String srcName, @Nullable String srcDesc)
void	visitMetadata(String key, @Nullable String value)
boolean	visitMethod(String srcName, @Nullable String srcDesc)
boolean	visitMethodArg(int argPosition, int lvIndex, @Nullable String srcName)
boolean	visitMethodVar(int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName)
void	visitNamespaces(String srcNamespace, List<String> dstNamespaces)

Methods inherited from class java.lang.Object

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

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

getField, getField, getMethod, getMethod

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

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

Methods inherited from interface net.fabricmc.mappingio.MappingVisitor

getFlags, visitContent, visitDstDesc, visitHeader

Constructor Details

MemoryMappingTree

public MemoryMappingTree()

MemoryMappingTree

public MemoryMappingTree(boolean indexByDstNames)

MemoryMappingTree

public MemoryMappingTree(MappingTree src)

Method Details

setIndexByDstNames

public void setIndexByDstNames(boolean indexByDstNames)

setHierarchyInfoProvider

public void setHierarchyInfoProvider(@Nullable
 @Nullable HierarchyInfoProvider<?> provider)

getSrcNamespace

@Nullable
public @Nullable String getSrcNamespace()

Specified by:

getSrcNamespace in interface MappingTreeView

Returns:

The source namespace, or null if the tree is uninitialized.

setSrcNamespace

@Nullable
public @Nullable String setSrcNamespace(String namespace)

Specified by:

setSrcNamespace in interface MappingTree

getDstNamespaces

public List<String> getDstNamespaces()

Specified by:

getDstNamespaces in interface MappingTreeView

Returns:

A list containing the destination namespaces, in order of their IDs. Can only be empty if the tree is uninitialized.

setDstNamespaces

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

Specified by:

setDstNamespaces in interface MappingTree

getMetadata

public List<? extends MappingTree.MetadataEntry> getMetadata()

Specified by:

getMetadata in interface MappingTree

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

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

Specified by:

getMetadata in interface MappingTree

Specified by:

getMetadata in interface MappingTreeView

Returns:

An unmodifiable list of all metadata entries currently present in the tree 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

public void addMetadata(MappingTree.MetadataEntry entry)

Specified by:

addMetadata in interface MappingTree

removeMetadata

public boolean removeMetadata(String key)

Description copied from interface: MappingTree

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

Specified by:

removeMetadata in interface MappingTree

Returns:

Whether or not any entries have been removed.

getClasses

public Collection<? extends MappingTree.ClassMapping> getClasses()

Specified by:

getClasses in interface MappingTree

Specified by:

getClasses in interface MappingTreeView

getClass

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

Specified by:

getClass in interface MappingTree

Specified by:

getClass in interface MappingTreeView

getClass

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

Specified by:

getClass in interface MappingTree

Specified by:

getClass in interface MappingTreeView

addClass

public MappingTree.ClassMapping addClass(MappingTree.ClassMapping cls)

Specified by:

addClass in interface MappingTree

removeClass

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

Specified by:

removeClass in interface MappingTree

accept

public void accept(MappingVisitor visitor,
 VisitOrder order)
            throws IOException

Specified by:

accept in interface MappingTreeView

Throws:

IOException

reset

public void reset()

Description copied from interface: MappingVisitor

Reset the visitor including any chained visitors to allow for another independent visit (excluding visitEnd=false).

Specified by:

reset in interface MappingVisitor

visitNamespaces

public void visitNamespaces(String srcNamespace,
 List<String> dstNamespaces)

Specified by:

visitNamespaces in interface MappingVisitor

visitMetadata

public void visitMetadata(String key,
 @Nullable
 @Nullable String value)

Specified by:

visitMetadata in interface MappingVisitor

visitClass

public boolean visitClass(String srcName)

Specified by:

visitClass in interface MappingVisitor

visitField

public boolean visitField(String srcName,
 @Nullable
 @Nullable String srcDesc)

Specified by:

visitField in interface MappingVisitor

visitMethod

public boolean visitMethod(String srcName,
 @Nullable
 @Nullable String srcDesc)

Specified by:

visitMethod in interface MappingVisitor

visitMethodArg

public boolean visitMethodArg(int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcName)

Specified by:

visitMethodArg in interface MappingVisitor

visitMethodVar

public boolean visitMethodVar(int lvtRowIndex,
 int lvIndex,
 int startOpIdx,
 int endOpIdx,
 @Nullable
 @Nullable String srcName)

Specified by:

visitMethodVar in interface MappingVisitor

visitEnd

public boolean visitEnd()

Description copied from interface: MappingVisitor

Finish the visitation pass.

Specified by:

visitEnd in interface MappingVisitor

Returns:

true if the visitation pass is final, false if it should be started over

visitDstName

public void visitDstName(MappedElementKind targetKind,
 int namespace,
 String name)

Description copied from interface: MappingVisitor

Destination name for the current element.

Specified by:

visitDstName in interface MappingVisitor

Parameters:

namespace - namespace index, index into the dstNamespaces List in MappingVisitor.visitNamespaces(java.lang.String, java.util.List<java.lang.String>)

name - destination name

visitElementContent

public boolean visitElementContent(MappedElementKind targetKind)
                            throws IOException

Description copied from interface: MappingVisitor

Determine whether the element content (comment, sub-elements) should be visited.

Called after visiting the target itself (e.g. visitClass for targetKind=class), its dst names and descs, but before any child elements or the comment.

This is also a notification about all available dst names having been passed on.

Specified by:

visitElementContent in interface MappingVisitor

Returns:

true if the contents are to be visited, false otherwise

Throws:

IOException

visitComment

public void visitComment(MappedElementKind targetKind,
 String comment)

Description copied from interface: MappingVisitor

Comment for the specified element (last content-visited or any parent).

Specified by:

visitComment in interface MappingVisitor

Parameters:

comment - comment as a potentially multi-line string