Package net.fabricmc.mappingio.format.srg

Class SrgFileWriter

java.lang.Object

net.fabricmc.mappingio.format.srg.SrgFileWriter

All Implemented Interfaces:

Closeable, AutoCloseable, MappingVisitor, MappingWriter

public final class SrgFileWriter
extends Object
implements MappingWriter

Constructor Summary

Constructors

Constructor	Description
SrgFileWriter(Writer writer, boolean xsrg)

Method Summary

Modifier and Type	Method	Description
void	close()
Set<MappingFlag>	getFlags()
boolean	visitClass(String srcName)
void	visitComment(MappedElementKind targetKind, String comment)	Comment for the specified element (last content-visited or any parent).
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	visitField(String srcName, @Nullable String srcDesc)
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.MappingVisitor

reset, visitContent, visitHeader, visitMetadata

Methods inherited from interface net.fabricmc.mappingio.MappingWriter

visitEnd

Constructor Details

SrgFileWriter

public SrgFileWriter(Writer writer,
 boolean xsrg)

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getFlags

public Set<MappingFlag> getFlags()

Specified by:

getFlags in interface MappingVisitor

visitNamespaces

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

Specified by:

visitNamespaces in interface MappingVisitor

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

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

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