Interface FlatMappingVisitor

All Known Implementing Classes:

RegularAsFlatMappingVisitor, SubsetChecker

public interface FlatMappingVisitor

A mapping visitor that provides the entire data for a given element within a single visit call.

Method Summary

Modifier and Type	Method	Description
default MappingVisitor	asRegularVisitor()
static FlatMappingVisitor	fromRegularVisitor(MappingVisitor visitor)
default Set<MappingFlag>	getFlags()
default void	reset()
boolean	visitClass(String srcName, @Nullable String[] dstNames)
default boolean	visitClass(String srcName, String dstName)
void	visitClassComment(String srcName, @Nullable String[] dstNames, String comment)
default void	visitClassComment(String srcName, @Nullable String dstName, String comment)
default void	visitClassComment(String srcName, String comment)
default boolean	visitContent()	Determine whether the mapping content (classes and anything below, metadata if not part of the header) should be visited.
default boolean	visitEnd()	Finish the visitation pass.
boolean	visitField(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs)
default boolean	visitField(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String dstClsName, String dstName, @Nullable String dstDesc)
default boolean	visitField(String srcClsName, String srcName, @Nullable String srcDesc, String dstName)
default boolean	visitField(String srcClsName, String srcName, @Nullable String srcDesc, String[] dstNames)
void	visitFieldComment(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs, String comment)
default void	visitFieldComment(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String dstClsName, @Nullable String dstName, @Nullable String dstDesc, String comment)
default void	visitFieldComment(String srcClsName, String srcName, @Nullable String srcDesc, String comment)
default boolean	visitHeader()	Determine whether the header (namespaces, metadata if part of the header) should be visited.
default void	visitMetadata(String key, @Nullable String value)
boolean	visitMethod(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs)
default boolean	visitMethod(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String dstClsName, String dstName, @Nullable String dstDesc)
default boolean	visitMethod(String srcClsName, String srcName, @Nullable String srcDesc, String dstName)
default boolean	visitMethod(String srcClsName, String srcName, @Nullable String srcDesc, String[] dstNames)
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, String[] dstNames)
default boolean	visitMethodArg(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcName, @Nullable String dstClsName, @Nullable String dstMethodName, @Nullable String dstMethodDesc, String dstName)
default boolean	visitMethodArg(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcName, String dstName)
default boolean	visitMethodArg(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcName, String[] dstNames)
void	visitMethodArgComment(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, String comment)
default void	visitMethodArgComment(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcName, @Nullable String dstClsName, @Nullable String dstMethodName, @Nullable String dstMethodDesc, @Nullable String dstName, String comment)
default void	visitMethodArgComment(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int argPosition, int lvIndex, @Nullable String srcName, String comment)
void	visitMethodComment(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String[] dstClsNames, @Nullable String[] dstNames, @Nullable String[] dstDescs, String comment)
default void	visitMethodComment(String srcClsName, String srcName, @Nullable String srcDesc, @Nullable String dstClsName, @Nullable String dstName, @Nullable String dstDesc, String comment)
default void	visitMethodComment(String srcClsName, String srcName, @Nullable String srcDesc, 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, String[] dstNames)
default boolean	visitMethodVar(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName, @Nullable String dstClsName, @Nullable String dstMethodName, @Nullable String dstMethodDesc, String dstName)
default boolean	visitMethodVar(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName, String dstName)
default boolean	visitMethodVar(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName, String[] dstNames)
void	visitMethodVarComment(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, String comment)
default void	visitMethodVarComment(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName, @Nullable String dstClsName, @Nullable String dstMethodName, @Nullable String dstMethodDesc, @Nullable String dstName, String comment)
default void	visitMethodVarComment(String srcClsName, String srcMethodName, @Nullable String srcMethodDesc, int lvtRowIndex, int lvIndex, int startOpIdx, int endOpIdx, @Nullable String srcName, String comment)
void	visitNamespaces(String srcNamespace, List<String> dstNamespaces)

Method Details

getFlags

default Set<MappingFlag> getFlags()

reset

default void reset()

visitHeader

default boolean visitHeader()
                     throws IOException

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

Returns:

true if the header is to be visited, false otherwise.

Throws:

IOException

visitNamespaces

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

Throws:

IOException

visitMetadata

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

Throws:

IOException

visitContent

default boolean visitContent()
                      throws IOException

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

Returns:

true if content is to be visited, false otherwise.

Throws:

IOException

visitClass

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

Throws:

IOException

visitClassComment

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

Throws:

IOException

visitField

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

Throws:

IOException

visitFieldComment

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

Throws:

IOException

visitMethod

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

Throws:

IOException

visitMethodComment

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

Throws:

IOException

visitMethodArg

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,
 String[] dstNames)
                throws IOException

Throws:

IOException

visitMethodArgComment

void visitMethodArgComment(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,
 String comment)
                    throws IOException

Throws:

IOException

visitMethodVar

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,
 String[] dstNames)
                throws IOException

Throws:

IOException

visitMethodVarComment

void visitMethodVarComment(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,
 String comment)
                    throws IOException

Throws:

IOException

visitEnd

default boolean visitEnd()
                  throws IOException

Finish the visitation pass.

Returns:

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

Throws:

IOException

asRegularVisitor

default MappingVisitor asRegularVisitor()

fromRegularVisitor

static FlatMappingVisitor fromRegularVisitor(MappingVisitor visitor)

visitField

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

Throws:

IOException

visitMethod

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

Throws:

IOException

visitMethodArg

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

Throws:

IOException

visitMethodVar

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

Throws:

IOException

visitClass

default boolean visitClass(String srcName,
 String dstName)
                    throws IOException

Throws:

IOException

visitClassComment

default void visitClassComment(String srcName,
 String comment)
                        throws IOException

Throws:

IOException

visitClassComment

default void visitClassComment(String srcName,
 @Nullable
 @Nullable String dstName,
 String comment)
                        throws IOException

Throws:

IOException

visitField

default boolean visitField(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 String dstName)
                    throws IOException

Throws:

IOException

visitField

default boolean visitField(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String dstClsName,
 String dstName,
 @Nullable
 @Nullable String dstDesc)
                    throws IOException

Throws:

IOException

visitFieldComment

default void visitFieldComment(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 String comment)
                        throws IOException

Throws:

IOException

visitFieldComment

default void visitFieldComment(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String dstClsName,
 @Nullable
 @Nullable String dstName,
 @Nullable
 @Nullable String dstDesc,
 String comment)
                        throws IOException

Throws:

IOException

visitMethod

default boolean visitMethod(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 String dstName)
                     throws IOException

Throws:

IOException

visitMethod

default boolean visitMethod(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String dstClsName,
 String dstName,
 @Nullable
 @Nullable String dstDesc)
                     throws IOException

Throws:

IOException

visitMethodComment

default void visitMethodComment(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 String comment)
                         throws IOException

Throws:

IOException

visitMethodComment

default void visitMethodComment(String srcClsName,
 String srcName,
 @Nullable
 @Nullable String srcDesc,
 @Nullable
 @Nullable String dstClsName,
 @Nullable
 @Nullable String dstName,
 @Nullable
 @Nullable String dstDesc,
 String comment)
                         throws IOException

Throws:

IOException

visitMethodArg

default boolean visitMethodArg(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcName,
 String dstName)
                        throws IOException

Throws:

IOException

visitMethodArg

default boolean visitMethodArg(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcName,
 @Nullable
 @Nullable String dstClsName,
 @Nullable
 @Nullable String dstMethodName,
 @Nullable
 @Nullable String dstMethodDesc,
 String dstName)
                        throws IOException

Throws:

IOException

visitMethodArgComment

default void visitMethodArgComment(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcName,
 String comment)
                            throws IOException

Throws:

IOException

visitMethodArgComment

default void visitMethodArgComment(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int argPosition,
 int lvIndex,
 @Nullable
 @Nullable String srcName,
 @Nullable
 @Nullable String dstClsName,
 @Nullable
 @Nullable String dstMethodName,
 @Nullable
 @Nullable String dstMethodDesc,
 @Nullable
 @Nullable String dstName,
 String comment)
                            throws IOException

Throws:

IOException

visitMethodVar

default boolean visitMethodVar(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int lvtRowIndex,
 int lvIndex,
 int startOpIdx,
 int endOpIdx,
 @Nullable
 @Nullable String srcName,
 String dstName)
                        throws IOException

Throws:

IOException

visitMethodVar

default 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 dstClsName,
 @Nullable
 @Nullable String dstMethodName,
 @Nullable
 @Nullable String dstMethodDesc,
 String dstName)
                        throws IOException

Throws:

IOException

visitMethodVarComment

default void visitMethodVarComment(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int lvtRowIndex,
 int lvIndex,
 int startOpIdx,
 int endOpIdx,
 @Nullable
 @Nullable String srcName,
 String comment)
                            throws IOException

Throws:

IOException

visitMethodVarComment

default void visitMethodVarComment(String srcClsName,
 String srcMethodName,
 @Nullable
 @Nullable String srcMethodDesc,
 int lvtRowIndex,
 int lvIndex,
 int startOpIdx,
 int endOpIdx,
 @Nullable
 @Nullable String srcName,
 @Nullable
 @Nullable String dstClsName,
 @Nullable
 @Nullable String dstMethodName,
 @Nullable
 @Nullable String dstMethodDesc,
 @Nullable
 @Nullable String dstName,
 String comment)
                            throws IOException

Throws:

IOException