net.neoforged.srgutils

Interface IMappingFile

public interface IMappingFile

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IMappingFile.Format
static interface	IMappingFile.IClass
static interface	IMappingFile.IField
static interface	IMappingFile.IMethod
static interface	IMappingFile.INode
static interface	IMappingFile.IOwnedNode<T>
static interface	IMappingFile.IPackage
static interface	IMappingFile.IParameter

Method Summary

Modifier and Type	Method and Description
IMappingFile	chain(IMappingFile other) Chains this mapping file with another.
IMappingFile.IClass	getClass(java.lang.String original)
java.util.Collection<? extends IMappingFile.IClass>	getClasses()
IMappingFile.IPackage	getPackage(java.lang.String original)
java.util.Collection<? extends IMappingFile.IPackage>	getPackages()
static IMappingFile	load(java.io.File path)
static IMappingFile	load(java.io.InputStream in)
IMappingFile	merge(IMappingFile other) Merges this mapping file with another.
java.lang.String	remapClass(java.lang.String desc)
java.lang.String	remapDescriptor(java.lang.String desc)
java.lang.String	remapPackage(java.lang.String pkg)
IMappingFile	rename(IRenamer renamer)
IMappingFile	reverse()
void	write(java.nio.file.Path path, IMappingFile.Format format, boolean reversed)

Method Detail

load

static IMappingFile load(java.io.File path)
                  throws java.io.IOException

Throws:

java.io.IOException

load

static IMappingFile load(java.io.InputStream in)
                  throws java.io.IOException

Throws:

java.io.IOException

getPackages

java.util.Collection<? extends IMappingFile.IPackage> getPackages()

getPackage

IMappingFile.IPackage getPackage(java.lang.String original)

getClasses

java.util.Collection<? extends IMappingFile.IClass> getClasses()

getClass

IMappingFile.IClass getClass(java.lang.String original)

remapPackage

java.lang.String remapPackage(java.lang.String pkg)

remapClass

java.lang.String remapClass(java.lang.String desc)

remapDescriptor

java.lang.String remapDescriptor(java.lang.String desc)

write

void write(java.nio.file.Path path,
           IMappingFile.Format format,
           boolean reversed)
    throws java.io.IOException

Throws:

java.io.IOException

reverse

IMappingFile reverse()

rename

IMappingFile rename(IRenamer renamer)

chain

IMappingFile chain(IMappingFile other)

Chains this mapping file with another. Any extra mappings in the other file that is not used are discarded. For example: A mapping file with A → B chained with a mapping file B → C will result in a chained file of A → C.

Parameters:

other - the other mapping file to chain with

Returns:

the resulting chained mapping file

merge

IMappingFile merge(IMappingFile other)

Merges this mapping file with another. Any mappings in the other file that already exist in this file will be discarded. All entries in this mapping file are preserved. This operation is purely additive based on the contents of the other file.

Parameters:

other - the other mapping file to merge into this one

Returns:

the resulting merged mapping file