Package net.fabricmc.mappingio.adapter

Class ForwardingMappingVisitor

java.lang.Object

net.fabricmc.mappingio.adapter.ForwardingMappingVisitor

All Implemented Interfaces:

MappingVisitor

Direct Known Subclasses:

MappingDstNsReorder, MappingNsCompleter, MappingNsRenamer, MappingSourceNsSwitch, MissingDescFilter

public abstract class ForwardingMappingVisitor
extends Object
implements MappingVisitor

Field Summary

Fields

Modifier and Type	Field	Description
protected final MappingVisitor	next

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingMappingVisitor(MappingVisitor next)

Method Summary

Modifier and Type	Method	Description
Set<MappingFlag>	getFlags()
void	reset()	Reset the visitor including any chained visitors to allow for another independent visit (excluding visitEnd=false).
boolean	visitClass(String srcName)
void	visitComment(MappedElementKind targetKind, String comment)	Comment for the specified element (last content-visited or any parent).
boolean	visitContent()	Determine whether the mapping content (classes and anything below, metadata if not part of the header) should be visited.
void	visitDstDesc(MappedElementKind targetKind, int namespace, String desc)
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)
boolean	visitHeader()	Determine whether the header (namespaces, metadata if part of the header) should be visited.
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

Field Details

next

protected final MappingVisitor next

Constructor Details

ForwardingMappingVisitor

protected ForwardingMappingVisitor(MappingVisitor next)

Method Details

getFlags

public Set<MappingFlag> getFlags()

Specified by:

getFlags in interface MappingVisitor

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

visitHeader

public boolean visitHeader()
                    throws IOException

Description copied from interface: MappingVisitor

Determine whether the header (namespaces, metadata if part of the header) should be visited.

Specified by:

visitHeader in interface MappingVisitor

Returns:

true if the header is to be visited, false otherwise

Throws:

IOException

visitNamespaces

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

Specified by:

visitNamespaces in interface MappingVisitor

Throws:

IOException

visitMetadata

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

Specified by:

visitMetadata in interface MappingVisitor

Throws:

IOException

visitContent

public boolean visitContent()
                     throws IOException

Description copied from interface: MappingVisitor

Determine whether the mapping content (classes and anything below, metadata if not part of the header) should be visited.

Specified by:

visitContent in interface MappingVisitor

Returns:

true if content is to be visited, false otherwise

Throws:

IOException

visitClass

public boolean visitClass(String srcName)
                   throws IOException

Specified by:

visitClass in interface MappingVisitor

Throws:

IOException

visitField

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

Specified by:

visitField in interface MappingVisitor

Throws:

IOException

visitMethod

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

Specified by:

visitMethod in interface MappingVisitor

Throws:

IOException

visitMethodArg

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

Specified by:

visitMethodArg in interface MappingVisitor

Throws:

IOException

visitMethodVar

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

Specified by:

visitMethodVar in interface MappingVisitor

Throws:

IOException

visitEnd

public boolean visitEnd()
                 throws IOException

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

Throws:

IOException

visitDstName

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

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

Throws:

IOException

visitDstDesc

public void visitDstDesc(MappedElementKind targetKind,
 int namespace,
 String desc)
                  throws IOException

Specified by:

visitDstDesc in interface MappingVisitor

Throws:

IOException

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)
                  throws IOException

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

Throws:

IOException