Class SubsetChecker

java.lang.Object

net.fabricmc.mappingio.adapter.SubsetChecker

All Implemented Interfaces:

FlatMappingVisitor

@Experimental
public class SubsetChecker
extends Object
implements FlatMappingVisitor

A visitor which checks whether the visited mappings are a subset of a superset tree.

Experimental feature, may be removed or changed without further notice.

Constructor Summary

Constructors

Constructor	Description
SubsetChecker(MappingTreeView supTree, @Nullable MappingFormat supFormat, @Nullable MappingFormat subFormat, Consumer<String> errorHandler)

Method Summary

Modifier and Type	Method	Description
protected void	assertEquals(Object expected, Object actual, String message)
protected void	assertFalse(boolean condition, String message)
protected void	assertNotNull(Object obj, String message)
protected void	assertTrue(boolean condition, String message)
boolean	visitClass(String srcName, @Nullable String[] dstNames)
void	visitClassComment(String srcName, @Nullable String[] dstNames, String comment)
boolean	visitField(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs)
void	visitFieldComment(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs, String comment)
boolean	visitMethod(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs)
boolean	visitMethodArg(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcName, @Nullable String[] dstClsNames, @Nullable String[] dstMethodNames, @Nullable String[] dstMethodDescs, @Nullable String[] dstNames)
void	visitMethodArgComment(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcArgName, @Nullable String[] dstClsNames, @Nullable String[] dstMethodNames, @Nullable String[] dstMethodDescs, @Nullable String[] dstNames, String comment)
void	visitMethodComment(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs, String comment)
boolean	visitMethodVar(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName, @Nullable String[] dstClsNames, @Nullable String[] dstMethodNames, @Nullable String[] dstMethodDescs, @Nullable String[] dstNames)
void	visitMethodVarComment(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcVarName, @Nullable String[] dstClsNames, @Nullable String[] dstMethodNames, @Nullable String[] dstMethodDescs, @Nullable String[] dstNames, String comment)
void	visitNamespaces(String srcNamespace, List<String> dstNamespaces)

Methods inherited from class Object

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

Methods inherited from interface FlatMappingVisitor

asRegularVisitor, getFlags, reset, visitClass, visitClassComment, visitClassComment, visitContent, visitEnd, visitField, visitField, visitField, visitFieldComment, visitFieldComment, visitHeader, visitMetadata, visitMethod, visitMethod, visitMethod, visitMethodArg, visitMethodArg, visitMethodArg, visitMethodArgComment, visitMethodArgComment, visitMethodComment, visitMethodComment, visitMethodVar, visitMethodVar, visitMethodVar, visitMethodVarComment, visitMethodVarComment

Constructor Details

SubsetChecker

public SubsetChecker(MappingTreeView supTree,
 @Nullable
 @Nullable MappingFormat supFormat,
 @Nullable
 @Nullable MappingFormat subFormat,
 Consumer<String> errorHandler)

Parameters:

supTree - The superset tree.

supFormat - The superset format, or null if supTree has all the original data.

subFormat - The subset format, or null if lossless (e.g. if the visit calls are coming from a tree).

errorHandler - The error handler, which will be called with the error message if a non-subset element is found. Currently expected to throw an exception, otherwise the checker will continue to run in an invalid state.

Method Details

visitNamespaces

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

Specified by:

visitNamespaces in interface FlatMappingVisitor

Throws:

IOException

visitClass

public boolean visitClass(String srcName,
 @Nullable
 @Nullable String[] dstNames)
                   throws IOException

Specified by:

visitClass in interface FlatMappingVisitor

Throws:

IOException

visitClassComment

public void visitClassComment(String srcName,
 @Nullable
 @Nullable String[] dstNames,
 String comment)
                       throws IOException

Specified by:

visitClassComment in interface FlatMappingVisitor

Throws:

IOException

visitField

public boolean visitField(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstNames,
 @Nullable
 @Nullable String[] dstDescs)
                   throws IOException

Specified by:

visitField in interface FlatMappingVisitor

Throws:

IOException

visitFieldComment

public void visitFieldComment(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstNames,
 @Nullable
 @Nullable String[] dstDescs,
 String comment)
                       throws IOException

Specified by:

visitFieldComment in interface FlatMappingVisitor

Throws:

IOException

visitMethod

public boolean visitMethod(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstNames,
 @Nullable
 @Nullable String[] dstDescs)
                    throws IOException

Specified by:

visitMethod in interface FlatMappingVisitor

Throws:

IOException

visitMethodComment

public void visitMethodComment(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstNames,
 @Nullable
 @Nullable String[] dstDescs,
 String comment)
                        throws IOException

Specified by:

visitMethodComment in interface FlatMappingVisitor

Throws:

IOException

visitMethodArg

public boolean visitMethodArg(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcName,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstMethodNames,
 @Nullable
 @Nullable String[] dstMethodDescs,
 @Nullable
 @Nullable String[] dstNames)
                       throws IOException

Specified by:

visitMethodArg in interface FlatMappingVisitor

Throws:

IOException

visitMethodArgComment

public void visitMethodArgComment(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcArgName,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstMethodNames,
 @Nullable
 @Nullable String[] dstMethodDescs,
 @Nullable
 @Nullable String[] dstNames,
 String comment)
                           throws IOException

Specified by:

visitMethodArgComment in interface FlatMappingVisitor

Throws:

IOException

visitMethodVar

public boolean visitMethodVar(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int lvtRowIndex,
 int lvIndex,
 int startOpIdx,
 int endOpIdx,
 @Nullable
 @Nullable String srcName,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstMethodNames,
 @Nullable
 @Nullable String[] dstMethodDescs,
 @Nullable
 @Nullable String[] dstNames)
                       throws IOException

Specified by:

visitMethodVar in interface FlatMappingVisitor

Throws:

IOException

visitMethodVarComment

public void visitMethodVarComment(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int lvtRowIndex,
 int lvIndex,
 int startOpIdx,
 int endOpIdx,
 @Nullable
 @Nullable String srcVarName,
 @Nullable
 @Nullable String[] dstClsNames,
 @Nullable
 @Nullable String[] dstMethodNames,
 @Nullable
 @Nullable String[] dstMethodDescs,
 @Nullable
 @Nullable String[] dstNames,
 String comment)
                           throws IOException

Specified by:

visitMethodVarComment in interface FlatMappingVisitor

Throws:

IOException

assertTrue

protected void assertTrue(boolean condition,
 String message)

assertFalse

protected void assertFalse(boolean condition,
 String message)

assertEquals

protected void assertEquals(Object expected,
 Object actual,
 String message)

assertNotNull

protected void assertNotNull(Object obj,
 String message)