Package net.fabricmc.mappingio.format.proguard

Class ProGuardFileWriter

java.lang.Object

net.fabricmc.mappingio.format.proguard.ProGuardFileWriter

All Implemented Interfaces:

Closeable, AutoCloseable, MappingVisitor, MappingWriter

public final class ProGuardFileWriter
extends Object
implements MappingWriter

A mapping writer for the ProGuard mapping format. Note that this format is very basic: it only supports one namespace pair and only classes, methods and fields without comments.

See Also:

• Official format documentation

Constructor Summary

Constructors

Constructor	Description
ProGuardFileWriter(Writer writer)	Constructs a ProGuard mapping writer that uses the first destination namespace (index 0).
ProGuardFileWriter(Writer writer, int dstNamespace)	Constructs a ProGuard mapping writer.
ProGuardFileWriter(Writer writer, String dstNamespace)	Constructs a ProGuard mapping writer.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the internal Writer.
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	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

getFlags, reset, visitContent, visitDstDesc, visitElementContent, visitHeader, visitMetadata

Methods inherited from interface net.fabricmc.mappingio.MappingWriter

visitEnd

Constructor Details

ProGuardFileWriter

public ProGuardFileWriter(Writer writer)

Constructs a ProGuard mapping writer that uses the first destination namespace (index 0).

Parameters:

writer - the writer where the mappings will be written

ProGuardFileWriter

public ProGuardFileWriter(Writer writer,
 int dstNamespace)

Constructs a ProGuard mapping writer.

Parameters:

writer - the writer where the mappings will be written

dstNamespace - the namespace index to write as the destination namespace, must be at least 0

ProGuardFileWriter

public ProGuardFileWriter(Writer writer,
 String dstNamespace)

Constructs a ProGuard mapping writer.

Parameters:

writer - the writer where the mappings will be written

dstNamespace - the namespace name to write as the destination namespace

Method Details

close

public void close()
           throws IOException

Closes the internal Writer.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an IO error occurs

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

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